3 * https://www.mediawiki.org/wiki/OOjs_UI
5 * Copyright 2011–2016 OOjs UI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: 2016-02-22T22:33:33Z
16 * DraggableElement is a mixin class used to create elements that can be clicked
17 * and dragged by a mouse to a new position within a group. This class must be used
18 * in conjunction with OO.ui.mixin.DraggableGroupElement, which provides a container for
19 * the draggable elements.
25 * @param {Object} [config] Configuration options
26 * @cfg {jQuery} [$handle] The part of the element which can be used for dragging, defaults to the whole element
28 OO
.ui
.mixin
.DraggableElement
= function OoUiMixinDraggableElement( config
) {
29 config
= config
|| {};
33 this.$handle
= config
.$handle
|| this.$element
;
34 this.wasHandleUsed
= null;
36 // Initialize and events
37 this.$element
.addClass( 'oo-ui-draggableElement' )
38 // We make the entire element draggable, not just the handle, so that
39 // the whole element appears to move. wasHandleUsed prevents drags from
40 // starting outside the handle
41 .attr( 'draggable', true )
43 mousedown
: this.onDragMouseDown
.bind( this ),
44 dragstart
: this.onDragStart
.bind( this ),
45 dragover
: this.onDragOver
.bind( this ),
46 dragend
: this.onDragEnd
.bind( this ),
47 drop
: this.onDrop
.bind( this )
49 this.$handle
.addClass( 'oo-ui-draggableElement-handle' );
52 OO
.initClass( OO
.ui
.mixin
.DraggableElement
);
59 * A dragstart event is emitted when the user clicks and begins dragging an item.
60 * @param {OO.ui.mixin.DraggableElement} item The item the user has clicked and is dragging with the mouse.
65 * A dragend event is emitted when the user drags an item and releases the mouse,
66 * thus terminating the drag operation.
71 * A drop event is emitted when the user drags an item and then releases the mouse button
72 * over a valid target.
75 /* Static Properties */
78 * @inheritdoc OO.ui.mixin.ButtonElement
80 OO
.ui
.mixin
.DraggableElement
.static.cancelButtonMouseDownEvents
= false;
85 * Respond to mousedown event.
88 * @param {jQuery.Event} event jQuery event
90 OO
.ui
.mixin
.DraggableElement
.prototype.onDragMouseDown = function ( e
) {
92 // Optimization: if the handle is the whole element this is always true
93 this.$handle
[ 0 ] === this.$element
[ 0 ] ||
94 // Check the mousedown occurred inside the handle
95 OO
.ui
.contains( this.$handle
[ 0 ], e
.target
, true );
99 * Respond to dragstart event.
102 * @param {jQuery.Event} event jQuery event
105 OO
.ui
.mixin
.DraggableElement
.prototype.onDragStart = function ( e
) {
107 dataTransfer
= e
.originalEvent
.dataTransfer
;
109 if ( !this.wasHandleUsed
) {
113 // Define drop effect
114 dataTransfer
.dropEffect
= 'none';
115 dataTransfer
.effectAllowed
= 'move';
117 // We must set up a dataTransfer data property or Firefox seems to
118 // ignore the fact the element is draggable.
120 dataTransfer
.setData( 'application-x/OOjs-UI-draggable', this.getIndex() );
122 // The above is only for Firefox. Move on if it fails.
124 // Briefly add a 'clone' class to style the browser's native drag image
125 this.$element
.addClass( 'oo-ui-draggableElement-clone' );
126 // Add placeholder class after the browser has rendered the clone
127 setTimeout( function () {
129 .removeClass( 'oo-ui-draggableElement-clone' )
130 .addClass( 'oo-ui-draggableElement-placeholder' );
133 this.emit( 'dragstart', this );
138 * Respond to dragend event.
143 OO
.ui
.mixin
.DraggableElement
.prototype.onDragEnd = function () {
144 this.$element
.removeClass( 'oo-ui-draggableElement-placeholder' );
145 this.emit( 'dragend' );
152 * @param {jQuery.Event} event jQuery event
155 OO
.ui
.mixin
.DraggableElement
.prototype.onDrop = function ( e
) {
157 this.emit( 'drop', e
);
161 * In order for drag/drop to work, the dragover event must
162 * return false and stop propogation.
166 OO
.ui
.mixin
.DraggableElement
.prototype.onDragOver = function ( e
) {
172 * Store it in the DOM so we can access from the widget drag event
175 * @param {number} Item index
177 OO
.ui
.mixin
.DraggableElement
.prototype.setIndex = function ( index
) {
178 if ( this.index
!== index
) {
180 this.$element
.data( 'index', index
);
188 * @return {number} Item index
190 OO
.ui
.mixin
.DraggableElement
.prototype.getIndex = function () {
195 * DraggableGroupElement is a mixin class used to create a group element to
196 * contain draggable elements, which are items that can be clicked and dragged by a mouse.
197 * The class is used with OO.ui.mixin.DraggableElement.
201 * @mixins OO.ui.mixin.GroupElement
204 * @param {Object} [config] Configuration options
205 * @cfg {string} [orientation] Item orientation: 'horizontal' or 'vertical'. The orientation
206 * should match the layout of the items. Items displayed in a single row
207 * or in several rows should use horizontal orientation. The vertical orientation should only be
208 * used when the items are displayed in a single column. Defaults to 'vertical'
210 OO
.ui
.mixin
.DraggableGroupElement
= function OoUiMixinDraggableGroupElement( config
) {
211 // Configuration initialization
212 config
= config
|| {};
214 // Parent constructor
215 OO
.ui
.mixin
.GroupElement
.call( this, config
);
218 this.orientation
= config
.orientation
|| 'vertical';
219 this.dragItem
= null;
222 this.itemsOrder
= null;
226 dragstart
: 'itemDragStart',
227 dragend
: 'itemDragEnd',
230 this.connect( this, {
231 itemDragStart
: 'onItemDragStart',
232 itemDrop
: 'onItemDropOrDragEnd',
233 itemDragEnd
: 'onItemDropOrDragEnd'
237 if ( Array
.isArray( config
.items
) ) {
238 this.addItems( config
.items
);
241 .addClass( 'oo-ui-draggableGroupElement' )
242 .append( this.$status
)
243 .toggleClass( 'oo-ui-draggableGroupElement-horizontal', this.orientation
=== 'horizontal' );
247 OO
.mixinClass( OO
.ui
.mixin
.DraggableGroupElement
, OO
.ui
.mixin
.GroupElement
);
252 * An item has been dragged to a new position, but not yet dropped.
255 * @param {OO.ui.mixin.DraggableElement} item Dragged item
256 * @param {number} [newIndex] New index for the item
260 * And item has been dropped at a new position.
263 * @param {OO.ui.mixin.DraggableElement} item Reordered item
264 * @param {number} [newIndex] New index for the item
270 * Respond to item drag start event
273 * @param {OO.ui.mixin.DraggableElement} item Dragged item
275 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onItemDragStart = function ( item
) {
276 // Make a shallow copy of this.items so we can re-order it during previews
277 // without affecting the original array.
278 this.itemsOrder
= this.items
.slice();
279 this.updateIndexes();
280 if ( this.orientation
=== 'horizontal' ) {
281 // Calculate and cache directionality on drag start - it's a little
282 // expensive and it shouldn't change while dragging.
283 this.dir
= this.$element
.css( 'direction' );
285 this.setDragItem( item
);
289 * Update the index properties of the items
291 OO
.ui
.mixin
.DraggableGroupElement
.prototype.updateIndexes = function () {
294 // Map the index of each object
295 for ( i
= 0, len
= this.itemsOrder
.length
; i
< len
; i
++ ) {
296 this.itemsOrder
[ i
].setIndex( i
);
301 * Handle drop or dragend event and switch the order of the items accordingly
304 * @param {OO.ui.mixin.DraggableElement} item Dropped item
306 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onItemDropOrDragEnd = function () {
307 var targetIndex
, originalIndex
,
308 item
= this.getDragItem();
310 // TODO: Figure out a way to configure a list of legally droppable
311 // elements even if they are not yet in the list
313 originalIndex
= this.items
.indexOf( item
);
314 // If the item has moved forward, add one to the index to account for the left shift
315 targetIndex
= item
.getIndex() + ( item
.getIndex() > originalIndex
? 1 : 0 );
316 this.reorder( this.getDragItem(), targetIndex
);
317 this.emit( 'reorder', this.getDragItem(), targetIndex
);
318 this.updateIndexes();
320 this.unsetDragItem();
321 // Return false to prevent propogation
326 * Respond to dragover event
329 * @param {jQuery.Event} event Dragover event
332 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onDragOver = function ( e
) {
333 var dragOverObj
, $optionWidget
, itemOffset
, itemMidpoint
, itemBoundingRect
,
334 itemSize
, cssOutput
, dragPosition
, overIndex
, itemPosition
, after
,
336 item
= this.getDragItem(),
337 dragItemIndex
= item
.getIndex(),
338 clientX
= e
.originalEvent
.clientX
,
339 clientY
= e
.originalEvent
.clientY
;
341 // Get the OptionWidget item we are dragging over
342 dragOverObj
= this.getElementDocument().elementFromPoint( clientX
, clientY
);
343 $optionWidget
= $( dragOverObj
).closest( '.oo-ui-draggableElement' );
344 if ( $optionWidget
[ 0 ] ) {
345 itemOffset
= $optionWidget
.offset();
346 itemBoundingRect
= $optionWidget
[ 0 ].getBoundingClientRect();
347 itemPosition
= $optionWidget
.position();
348 overIndex
= $optionWidget
.data( 'index' );
353 overIndex
!== dragItemIndex
355 if ( this.orientation
=== 'horizontal' ) {
356 // Calculate where the mouse is relative to the item width
357 itemSize
= itemBoundingRect
.width
;
358 itemMidpoint
= itemBoundingRect
.left
+ itemSize
/ 2;
359 dragPosition
= clientX
;
360 // Which side of the item we hover over will dictate
361 // where to drop the selected item, on the left or
364 left
: dragPosition
< itemMidpoint
? itemPosition
.left
: itemPosition
.left
+ itemSize
,
365 top
: itemPosition
.top
368 // Calculate where the mouse is relative to the item height
369 itemSize
= itemBoundingRect
.height
;
370 itemMidpoint
= itemBoundingRect
.top
+ itemSize
/ 2;
371 dragPosition
= clientY
;
372 // Which side of the item we hover over will dictate
373 // where to drop the selected item, on the top or
376 top
: dragPosition
< itemMidpoint
? itemPosition
.top
: itemPosition
.top
+ itemSize
,
377 left
: itemPosition
.left
380 // Store whether we are before or after an item to rearrange
381 // For horizontal layout, we need to account for RTL, as this is flipped
382 if ( this.orientation
=== 'horizontal' && this.dir
=== 'rtl' ) {
383 after
= dragPosition
< itemMidpoint
;
385 after
= dragPosition
> itemMidpoint
;
387 targetIndex
= overIndex
+ ( after
? 1 : 0 );
388 // Check the targetIndex isn't immediately to the left or right of the current item (a no-op)
389 if ( targetIndex
=== dragItemIndex
|| targetIndex
=== dragItemIndex
+ 1 ) {
393 if ( targetIndex
!== null ) {
394 if ( targetIndex
> 0 ) {
395 this.$group
.children().eq( targetIndex
- 1 ).after( item
.$element
);
397 this.$group
.prepend( item
.$element
);
399 // Move item in itemsOrder array. Needs to account for left shift if the item is moved forward.
400 this.itemsOrder
.splice( targetIndex
- ( targetIndex
> dragItemIndex
? 1 : 0 ), 0,
401 this.itemsOrder
.splice( dragItemIndex
, 1 )[ 0 ]
403 this.updateIndexes();
404 this.emit( 'drag', item
, targetIndex
);
411 * Reorder the items in the group
413 * @param {OO.ui.mixin.DraggableElement} item Reordered item
414 * @param {number} newIndex New index
416 OO
.ui
.mixin
.DraggableGroupElement
.prototype.reorder = function ( item
, newIndex
) {
417 this.addItems( [ item
], newIndex
);
423 * @param {OO.ui.mixin.DraggableElement} item Dragged item
425 OO
.ui
.mixin
.DraggableGroupElement
.prototype.setDragItem = function ( item
) {
426 this.dragItem
= item
;
427 this.$element
.on( 'dragover', this.onDragOver
.bind( this ) );
428 this.$element
.addClass( 'oo-ui-draggableGroupElement-dragging' );
432 * Unset the current dragged item
434 OO
.ui
.mixin
.DraggableGroupElement
.prototype.unsetDragItem = function () {
435 this.dragItem
= null;
436 this.$element
.off( 'dragover' );
437 this.$element
.removeClass( 'oo-ui-draggableGroupElement-dragging' );
441 * Get the item that is currently being dragged.
443 * @return {OO.ui.mixin.DraggableElement|null} The currently dragged item, or `null` if no item is being dragged
445 OO
.ui
.mixin
.DraggableGroupElement
.prototype.getDragItem = function () {
446 return this.dragItem
;
450 * RequestManager is a mixin that manages the lifecycle of a promise-backed request for a widget, such as
451 * the {@link OO.ui.mixin.LookupElement}.
458 OO
.ui
.mixin
.RequestManager
= function OoUiMixinRequestManager() {
459 this.requestCache
= {};
460 this.requestQuery
= null;
461 this.requestRequest
= null;
466 OO
.initClass( OO
.ui
.mixin
.RequestManager
);
469 * Get request results for the current query.
471 * @return {jQuery.Promise} Promise object which will be passed response data as the first argument of
472 * the done event. If the request was aborted to make way for a subsequent request, this promise
473 * may not be rejected, depending on what jQuery feels like doing.
475 OO
.ui
.mixin
.RequestManager
.prototype.getRequestData = function () {
477 value
= this.getRequestQuery(),
478 deferred
= $.Deferred(),
482 if ( Object
.prototype.hasOwnProperty
.call( this.requestCache
, value
) ) {
483 deferred
.resolve( this.requestCache
[ value
] );
485 if ( this.pushPending
) {
488 this.requestQuery
= value
;
489 ourRequest
= this.requestRequest
= this.getRequest();
491 .always( function () {
492 // We need to pop pending even if this is an old request, otherwise
493 // the widget will remain pending forever.
494 // TODO: this assumes that an aborted request will fail or succeed soon after
495 // being aborted, or at least eventually. It would be nice if we could popPending()
496 // at abort time, but only if we knew that we hadn't already called popPending()
498 if ( widget
.popPending
) {
502 .done( function ( response
) {
503 // If this is an old request (and aborting it somehow caused it to still succeed),
504 // ignore its success completely
505 if ( ourRequest
=== widget
.requestRequest
) {
506 widget
.requestQuery
= null;
507 widget
.requestRequest
= null;
508 widget
.requestCache
[ value
] = widget
.getRequestCacheDataFromResponse( response
);
509 deferred
.resolve( widget
.requestCache
[ value
] );
513 // If this is an old request (or a request failing because it's being aborted),
514 // ignore its failure completely
515 if ( ourRequest
=== widget
.requestRequest
) {
516 widget
.requestQuery
= null;
517 widget
.requestRequest
= null;
522 return deferred
.promise();
526 * Abort the currently pending request, if any.
530 OO
.ui
.mixin
.RequestManager
.prototype.abortRequest = function () {
531 var oldRequest
= this.requestRequest
;
533 // First unset this.requestRequest to the fail handler will notice
534 // that the request is no longer current
535 this.requestRequest
= null;
536 this.requestQuery
= null;
542 * Get the query to be made.
547 * @return {string} query to be used
549 OO
.ui
.mixin
.RequestManager
.prototype.getRequestQuery
= null;
552 * Get a new request object of the current query value.
557 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
559 OO
.ui
.mixin
.RequestManager
.prototype.getRequest
= null;
562 * Pre-process data returned by the request from #getRequest.
564 * The return value of this function will be cached, and any further queries for the given value
565 * will use the cache rather than doing API requests.
570 * @param {Mixed} response Response from server
571 * @return {Mixed} Cached result data
573 OO
.ui
.mixin
.RequestManager
.prototype.getRequestCacheDataFromResponse
= null;
576 * LookupElement is a mixin that creates a {@link OO.ui.FloatingMenuSelectWidget menu} of suggested values for
577 * a {@link OO.ui.TextInputWidget text input widget}. Suggested values are based on the characters the user types
578 * into the text input field and, in general, the menu is only displayed when the user types. If a suggested value is chosen
579 * from the lookup menu, that value becomes the value of the input field.
581 * Note that a new menu of suggested items is displayed when a value is chosen from the lookup menu. If this is
582 * not the desired behavior, disable lookup menus with the #setLookupsDisabled method, then set the value, then
585 * See the [OOjs UI demos][1] for an example.
587 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/index.html#widgets-apex-vector-ltr
593 * @param {Object} [config] Configuration options
594 * @cfg {jQuery} [$overlay] Overlay for the lookup menu; defaults to relative positioning
595 * @cfg {jQuery} [$container=this.$element] The container element. The lookup menu is rendered beneath the specified element.
596 * @cfg {boolean} [allowSuggestionsWhenEmpty=false] Request and display a lookup menu when the text input is empty.
597 * By default, the lookup menu is not generated and displayed until the user begins to type.
598 * @cfg {boolean} [highlightFirst=true] Whether the first lookup result should be highlighted (so, that the user can
599 * take it over into the input with simply pressing return) automatically or not.
601 OO
.ui
.mixin
.LookupElement
= function OoUiMixinLookupElement( config
) {
602 // Configuration initialization
603 config
= $.extend( { highlightFirst
: true }, config
);
605 // Mixin constructors
606 OO
.ui
.mixin
.RequestManager
.call( this, config
);
609 this.$overlay
= config
.$overlay
|| this.$element
;
610 this.lookupMenu
= new OO
.ui
.FloatingMenuSelectWidget( {
613 $container
: config
.$container
|| this.$element
616 this.allowSuggestionsWhenEmpty
= config
.allowSuggestionsWhenEmpty
|| false;
618 this.lookupsDisabled
= false;
619 this.lookupInputFocused
= false;
620 this.lookupHighlightFirstItem
= config
.highlightFirst
;
624 focus
: this.onLookupInputFocus
.bind( this ),
625 blur
: this.onLookupInputBlur
.bind( this ),
626 mousedown
: this.onLookupInputMouseDown
.bind( this )
628 this.connect( this, { change
: 'onLookupInputChange' } );
629 this.lookupMenu
.connect( this, {
630 toggle
: 'onLookupMenuToggle',
631 choose
: 'onLookupMenuItemChoose'
635 this.$element
.addClass( 'oo-ui-lookupElement' );
636 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupElement-menu' );
637 this.$overlay
.append( this.lookupMenu
.$element
);
642 OO
.mixinClass( OO
.ui
.mixin
.LookupElement
, OO
.ui
.mixin
.RequestManager
);
647 * Handle input focus event.
650 * @param {jQuery.Event} e Input focus event
652 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputFocus = function () {
653 this.lookupInputFocused
= true;
654 this.populateLookupMenu();
658 * Handle input blur event.
661 * @param {jQuery.Event} e Input blur event
663 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputBlur = function () {
664 this.closeLookupMenu();
665 this.lookupInputFocused
= false;
669 * Handle input mouse down event.
672 * @param {jQuery.Event} e Input mouse down event
674 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputMouseDown = function () {
675 // Only open the menu if the input was already focused.
676 // This way we allow the user to open the menu again after closing it with Esc
677 // by clicking in the input. Opening (and populating) the menu when initially
678 // clicking into the input is handled by the focus handler.
679 if ( this.lookupInputFocused
&& !this.lookupMenu
.isVisible() ) {
680 this.populateLookupMenu();
685 * Handle input change event.
688 * @param {string} value New input value
690 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputChange = function () {
691 if ( this.lookupInputFocused
) {
692 this.populateLookupMenu();
697 * Handle the lookup menu being shown/hidden.
700 * @param {boolean} visible Whether the lookup menu is now visible.
702 OO
.ui
.mixin
.LookupElement
.prototype.onLookupMenuToggle = function ( visible
) {
704 // When the menu is hidden, abort any active request and clear the menu.
705 // This has to be done here in addition to closeLookupMenu(), because
706 // MenuSelectWidget will close itself when the user presses Esc.
707 this.abortLookupRequest();
708 this.lookupMenu
.clearItems();
713 * Handle menu item 'choose' event, updating the text input value to the value of the clicked item.
716 * @param {OO.ui.MenuOptionWidget} item Selected item
718 OO
.ui
.mixin
.LookupElement
.prototype.onLookupMenuItemChoose = function ( item
) {
719 this.setValue( item
.getData() );
726 * @return {OO.ui.FloatingMenuSelectWidget}
728 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenu = function () {
729 return this.lookupMenu
;
733 * Disable or re-enable lookups.
735 * When lookups are disabled, calls to #populateLookupMenu will be ignored.
737 * @param {boolean} disabled Disable lookups
739 OO
.ui
.mixin
.LookupElement
.prototype.setLookupsDisabled = function ( disabled
) {
740 this.lookupsDisabled
= !!disabled
;
744 * Open the menu. If there are no entries in the menu, this does nothing.
749 OO
.ui
.mixin
.LookupElement
.prototype.openLookupMenu = function () {
750 if ( !this.lookupMenu
.isEmpty() ) {
751 this.lookupMenu
.toggle( true );
757 * Close the menu, empty it, and abort any pending request.
762 OO
.ui
.mixin
.LookupElement
.prototype.closeLookupMenu = function () {
763 this.lookupMenu
.toggle( false );
764 this.abortLookupRequest();
765 this.lookupMenu
.clearItems();
770 * Request menu items based on the input's current value, and when they arrive,
771 * populate the menu with these items and show the menu.
773 * If lookups have been disabled with #setLookupsDisabled, this function does nothing.
778 OO
.ui
.mixin
.LookupElement
.prototype.populateLookupMenu = function () {
780 value
= this.getValue();
782 if ( this.lookupsDisabled
|| this.isReadOnly() ) {
786 // If the input is empty, clear the menu, unless suggestions when empty are allowed.
787 if ( !this.allowSuggestionsWhenEmpty
&& value
=== '' ) {
788 this.closeLookupMenu();
789 // Skip population if there is already a request pending for the current value
790 } else if ( value
!== this.lookupQuery
) {
791 this.getLookupMenuItems()
792 .done( function ( items
) {
793 widget
.lookupMenu
.clearItems();
794 if ( items
.length
) {
798 widget
.initializeLookupMenuSelection();
800 widget
.lookupMenu
.toggle( false );
804 widget
.lookupMenu
.clearItems();
812 * Highlight the first selectable item in the menu, if configured.
817 OO
.ui
.mixin
.LookupElement
.prototype.initializeLookupMenuSelection = function () {
818 if ( this.lookupHighlightFirstItem
&& !this.lookupMenu
.getSelectedItem() ) {
819 this.lookupMenu
.highlightItem( this.lookupMenu
.getFirstSelectableItem() );
824 * Get lookup menu items for the current query.
827 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument of
828 * the done event. If the request was aborted to make way for a subsequent request, this promise
829 * will not be rejected: it will remain pending forever.
831 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuItems = function () {
832 return this.getRequestData().then( function ( data
) {
833 return this.getLookupMenuOptionsFromData( data
);
838 * Abort the currently pending lookup request, if any.
842 OO
.ui
.mixin
.LookupElement
.prototype.abortLookupRequest = function () {
847 * Get a new request object of the current lookup query value.
852 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
854 OO
.ui
.mixin
.LookupElement
.prototype.getLookupRequest
= null;
857 * Pre-process data returned by the request from #getLookupRequest.
859 * The return value of this function will be cached, and any further queries for the given value
860 * will use the cache rather than doing API requests.
865 * @param {Mixed} response Response from server
866 * @return {Mixed} Cached result data
868 OO
.ui
.mixin
.LookupElement
.prototype.getLookupCacheDataFromResponse
= null;
871 * Get a list of menu option widgets from the (possibly cached) data returned by
872 * #getLookupCacheDataFromResponse.
877 * @param {Mixed} data Cached result data, usually an array
878 * @return {OO.ui.MenuOptionWidget[]} Menu items
880 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuOptionsFromData
= null;
883 * Set the read-only state of the widget.
885 * This will also disable/enable the lookups functionality.
887 * @param {boolean} readOnly Make input read-only
890 OO
.ui
.mixin
.LookupElement
.prototype.setReadOnly = function ( readOnly
) {
892 // Note: Calling #setReadOnly this way assumes this is mixed into an OO.ui.TextInputWidget
893 OO
.ui
.TextInputWidget
.prototype.setReadOnly
.call( this, readOnly
);
895 // During construction, #setReadOnly is called before the OO.ui.mixin.LookupElement constructor
896 if ( this.isReadOnly() && this.lookupMenu
) {
897 this.closeLookupMenu();
904 * @inheritdoc OO.ui.mixin.RequestManager
906 OO
.ui
.mixin
.LookupElement
.prototype.getRequestQuery = function () {
907 return this.getValue();
911 * @inheritdoc OO.ui.mixin.RequestManager
913 OO
.ui
.mixin
.LookupElement
.prototype.getRequest = function () {
914 return this.getLookupRequest();
918 * @inheritdoc OO.ui.mixin.RequestManager
920 OO
.ui
.mixin
.LookupElement
.prototype.getRequestCacheDataFromResponse = function ( response
) {
921 return this.getLookupCacheDataFromResponse( response
);
925 * CardLayouts are used within {@link OO.ui.IndexLayout index layouts} to create cards that users can select and display
926 * from the index's optional {@link OO.ui.TabSelectWidget tab} navigation. Cards are usually not instantiated directly,
927 * rather extended to include the required content and functionality.
929 * Each card must have a unique symbolic name, which is passed to the constructor. In addition, the card's tab
930 * item is customized (with a label) using the #setupTabItem method. See
931 * {@link OO.ui.IndexLayout IndexLayout} for an example.
934 * @extends OO.ui.PanelLayout
937 * @param {string} name Unique symbolic name of card
938 * @param {Object} [config] Configuration options
939 * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] Label for card's tab
941 OO
.ui
.CardLayout
= function OoUiCardLayout( name
, config
) {
942 // Allow passing positional parameters inside the config object
943 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
948 // Configuration initialization
949 config
= $.extend( { scrollable
: true }, config
);
951 // Parent constructor
952 OO
.ui
.CardLayout
.parent
.call( this, config
);
956 this.label
= config
.label
;
961 this.$element
.addClass( 'oo-ui-cardLayout' );
966 OO
.inheritClass( OO
.ui
.CardLayout
, OO
.ui
.PanelLayout
);
971 * An 'active' event is emitted when the card becomes active. Cards become active when they are
972 * shown in a index layout that is configured to display only one card at a time.
975 * @param {boolean} active Card is active
981 * Get the symbolic name of the card.
983 * @return {string} Symbolic name of card
985 OO
.ui
.CardLayout
.prototype.getName = function () {
990 * Check if card is active.
992 * Cards become active when they are shown in a {@link OO.ui.IndexLayout index layout} that is configured to display
993 * only one card at a time. Additional CSS is applied to the card's tab item to reflect the active state.
995 * @return {boolean} Card is active
997 OO
.ui
.CardLayout
.prototype.isActive = function () {
1004 * The tab item allows users to access the card from the index's tab
1005 * navigation. The tab item itself can be customized (with a label, level, etc.) using the #setupTabItem method.
1007 * @return {OO.ui.TabOptionWidget|null} Tab option widget
1009 OO
.ui
.CardLayout
.prototype.getTabItem = function () {
1010 return this.tabItem
;
1014 * Set or unset the tab item.
1016 * Specify a {@link OO.ui.TabOptionWidget tab option} to set it,
1017 * or `null` to clear the tab item. To customize the tab item itself (e.g., to set a label or tab
1018 * level), use #setupTabItem instead of this method.
1020 * @param {OO.ui.TabOptionWidget|null} tabItem Tab option widget, null to clear
1023 OO
.ui
.CardLayout
.prototype.setTabItem = function ( tabItem
) {
1024 this.tabItem
= tabItem
|| null;
1026 this.setupTabItem();
1032 * Set up the tab item.
1034 * Use this method to customize the tab item (e.g., to add a label or tab level). To set or unset
1035 * the tab item itself (with a {@link OO.ui.TabOptionWidget tab option} or `null`), use
1036 * the #setTabItem method instead.
1038 * @param {OO.ui.TabOptionWidget} tabItem Tab option widget to set up
1041 OO
.ui
.CardLayout
.prototype.setupTabItem = function () {
1043 this.tabItem
.setLabel( this.label
);
1049 * Set the card to its 'active' state.
1051 * Cards become active when they are shown in a index layout that is configured to display only one card at a time. Additional
1052 * CSS is applied to the tab item to reflect the card's active state. Outside of the index
1053 * context, setting the active state on a card does nothing.
1055 * @param {boolean} value Card is active
1058 OO
.ui
.CardLayout
.prototype.setActive = function ( active
) {
1061 if ( active
!== this.active
) {
1062 this.active
= active
;
1063 this.$element
.toggleClass( 'oo-ui-cardLayout-active', this.active
);
1064 this.emit( 'active', this.active
);
1069 * PageLayouts are used within {@link OO.ui.BookletLayout booklet layouts} to create pages that users can select and display
1070 * from the booklet's optional {@link OO.ui.OutlineSelectWidget outline} navigation. Pages are usually not instantiated directly,
1071 * rather extended to include the required content and functionality.
1073 * Each page must have a unique symbolic name, which is passed to the constructor. In addition, the page's outline
1074 * item is customized (with a label, outline level, etc.) using the #setupOutlineItem method. See
1075 * {@link OO.ui.BookletLayout BookletLayout} for an example.
1078 * @extends OO.ui.PanelLayout
1081 * @param {string} name Unique symbolic name of page
1082 * @param {Object} [config] Configuration options
1084 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
1085 // Allow passing positional parameters inside the config object
1086 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
1091 // Configuration initialization
1092 config
= $.extend( { scrollable
: true }, config
);
1094 // Parent constructor
1095 OO
.ui
.PageLayout
.parent
.call( this, config
);
1099 this.outlineItem
= null;
1100 this.active
= false;
1103 this.$element
.addClass( 'oo-ui-pageLayout' );
1108 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
1113 * An 'active' event is emitted when the page becomes active. Pages become active when they are
1114 * shown in a booklet layout that is configured to display only one page at a time.
1117 * @param {boolean} active Page is active
1123 * Get the symbolic name of the page.
1125 * @return {string} Symbolic name of page
1127 OO
.ui
.PageLayout
.prototype.getName = function () {
1132 * Check if page is active.
1134 * Pages become active when they are shown in a {@link OO.ui.BookletLayout booklet layout} that is configured to display
1135 * only one page at a time. Additional CSS is applied to the page's outline item to reflect the active state.
1137 * @return {boolean} Page is active
1139 OO
.ui
.PageLayout
.prototype.isActive = function () {
1146 * The outline item allows users to access the page from the booklet's outline
1147 * navigation. The outline item itself can be customized (with a label, level, etc.) using the #setupOutlineItem method.
1149 * @return {OO.ui.OutlineOptionWidget|null} Outline option widget
1151 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
1152 return this.outlineItem
;
1156 * Set or unset the outline item.
1158 * Specify an {@link OO.ui.OutlineOptionWidget outline option} to set it,
1159 * or `null` to clear the outline item. To customize the outline item itself (e.g., to set a label or outline
1160 * level), use #setupOutlineItem instead of this method.
1162 * @param {OO.ui.OutlineOptionWidget|null} outlineItem Outline option widget, null to clear
1165 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
1166 this.outlineItem
= outlineItem
|| null;
1167 if ( outlineItem
) {
1168 this.setupOutlineItem();
1174 * Set up the outline item.
1176 * Use this method to customize the outline item (e.g., to add a label or outline level). To set or unset
1177 * the outline item itself (with an {@link OO.ui.OutlineOptionWidget outline option} or `null`), use
1178 * the #setOutlineItem method instead.
1180 * @param {OO.ui.OutlineOptionWidget} outlineItem Outline option widget to set up
1183 OO
.ui
.PageLayout
.prototype.setupOutlineItem = function () {
1188 * Set the page to its 'active' state.
1190 * Pages become active when they are shown in a booklet layout that is configured to display only one page at a time. Additional
1191 * CSS is applied to the outline item to reflect the page's active state. Outside of the booklet
1192 * context, setting the active state on a page does nothing.
1194 * @param {boolean} value Page is active
1197 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
1200 if ( active
!== this.active
) {
1201 this.active
= active
;
1202 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
1203 this.emit( 'active', this.active
);
1208 * StackLayouts contain a series of {@link OO.ui.PanelLayout panel layouts}. By default, only one panel is displayed
1209 * at a time, though the stack layout can also be configured to show all contained panels, one after another,
1210 * by setting the #continuous option to 'true'.
1213 * // A stack layout with two panels, configured to be displayed continously
1214 * var myStack = new OO.ui.StackLayout( {
1216 * new OO.ui.PanelLayout( {
1217 * $content: $( '<p>Panel One</p>' ),
1221 * new OO.ui.PanelLayout( {
1222 * $content: $( '<p>Panel Two</p>' ),
1229 * $( 'body' ).append( myStack.$element );
1232 * @extends OO.ui.PanelLayout
1233 * @mixins OO.ui.mixin.GroupElement
1236 * @param {Object} [config] Configuration options
1237 * @cfg {boolean} [continuous=false] Show all panels, one after another. By default, only one panel is displayed at a time.
1238 * @cfg {OO.ui.Layout[]} [items] Panel layouts to add to the stack layout.
1240 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
1241 // Configuration initialization
1242 config
= $.extend( { scrollable
: true }, config
);
1244 // Parent constructor
1245 OO
.ui
.StackLayout
.parent
.call( this, config
);
1247 // Mixin constructors
1248 OO
.ui
.mixin
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
1251 this.currentItem
= null;
1252 this.continuous
= !!config
.continuous
;
1255 this.$element
.addClass( 'oo-ui-stackLayout' );
1256 if ( this.continuous
) {
1257 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
1258 this.$element
.on( 'scroll', OO
.ui
.debounce( this.onScroll
.bind( this ), 250 ) );
1260 if ( Array
.isArray( config
.items
) ) {
1261 this.addItems( config
.items
);
1267 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
1268 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.mixin
.GroupElement
);
1273 * A 'set' event is emitted when panels are {@link #addItems added}, {@link #removeItems removed},
1274 * {@link #clearItems cleared} or {@link #setItem displayed}.
1277 * @param {OO.ui.Layout|null} item Current panel or `null` if no panel is shown
1281 * When used in continuous mode, this event is emitted when the user scrolls down
1282 * far enough such that currentItem is no longer visible.
1284 * @event visibleItemChange
1285 * @param {OO.ui.PanelLayout} panel The next visible item in the layout
1291 * Handle scroll events from the layout element
1293 * @param {jQuery.Event} e
1294 * @fires visibleItemChange
1296 OO
.ui
.StackLayout
.prototype.onScroll = function () {
1298 len
= this.items
.length
,
1299 currentIndex
= this.items
.indexOf( this.currentItem
),
1300 newIndex
= currentIndex
,
1301 containerRect
= this.$element
[ 0 ].getBoundingClientRect();
1303 if ( !containerRect
|| ( !containerRect
.top
&& !containerRect
.bottom
) ) {
1304 // Can't get bounding rect, possibly not attached.
1308 function getRect( item
) {
1309 return item
.$element
[ 0 ].getBoundingClientRect();
1312 function isVisible( item
) {
1313 var rect
= getRect( item
);
1314 return rect
.bottom
> containerRect
.top
&& rect
.top
< containerRect
.bottom
;
1317 currentRect
= getRect( this.currentItem
);
1319 if ( currentRect
.bottom
< containerRect
.top
) {
1320 // Scrolled down past current item
1321 while ( ++newIndex
< len
) {
1322 if ( isVisible( this.items
[ newIndex
] ) ) {
1326 } else if ( currentRect
.top
> containerRect
.bottom
) {
1327 // Scrolled up past current item
1328 while ( --newIndex
>= 0 ) {
1329 if ( isVisible( this.items
[ newIndex
] ) ) {
1335 if ( newIndex
!== currentIndex
) {
1336 this.emit( 'visibleItemChange', this.items
[ newIndex
] );
1341 * Get the current panel.
1343 * @return {OO.ui.Layout|null}
1345 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
1346 return this.currentItem
;
1350 * Unset the current item.
1353 * @param {OO.ui.StackLayout} layout
1356 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
1357 var prevItem
= this.currentItem
;
1358 if ( prevItem
=== null ) {
1362 this.currentItem
= null;
1363 this.emit( 'set', null );
1367 * Add panel layouts to the stack layout.
1369 * Panels will be added to the end of the stack layout array unless the optional index parameter specifies a different
1370 * insertion point. Adding a panel that is already in the stack will move it to the end of the array or the point specified
1373 * @param {OO.ui.Layout[]} items Panels to add
1374 * @param {number} [index] Index of the insertion point
1377 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
1378 // Update the visibility
1379 this.updateHiddenState( items
, this.currentItem
);
1382 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
, index
);
1384 if ( !this.currentItem
&& items
.length
) {
1385 this.setItem( items
[ 0 ] );
1392 * Remove the specified panels from the stack layout.
1394 * Removed panels are detached from the DOM, not removed, so that they may be reused. To remove all panels,
1395 * you may wish to use the #clearItems method instead.
1397 * @param {OO.ui.Layout[]} items Panels to remove
1401 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
1403 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
1405 if ( items
.indexOf( this.currentItem
) !== -1 ) {
1406 if ( this.items
.length
) {
1407 this.setItem( this.items
[ 0 ] );
1409 this.unsetCurrentItem();
1417 * Clear all panels from the stack layout.
1419 * Cleared panels are detached from the DOM, not removed, so that they may be reused. To remove only
1420 * a subset of panels, use the #removeItems method.
1425 OO
.ui
.StackLayout
.prototype.clearItems = function () {
1426 this.unsetCurrentItem();
1427 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
1433 * Show the specified panel.
1435 * If another panel is currently displayed, it will be hidden.
1437 * @param {OO.ui.Layout} item Panel to show
1441 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
1442 if ( item
!== this.currentItem
) {
1443 this.updateHiddenState( this.items
, item
);
1445 if ( this.items
.indexOf( item
) !== -1 ) {
1446 this.currentItem
= item
;
1447 this.emit( 'set', item
);
1449 this.unsetCurrentItem();
1457 * Update the visibility of all items in case of non-continuous view.
1459 * Ensure all items are hidden except for the selected one.
1460 * This method does nothing when the stack is continuous.
1463 * @param {OO.ui.Layout[]} items Item list iterate over
1464 * @param {OO.ui.Layout} [selectedItem] Selected item to show
1466 OO
.ui
.StackLayout
.prototype.updateHiddenState = function ( items
, selectedItem
) {
1469 if ( !this.continuous
) {
1470 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
1471 if ( !selectedItem
|| selectedItem
!== items
[ i
] ) {
1472 items
[ i
].$element
.addClass( 'oo-ui-element-hidden' );
1475 if ( selectedItem
) {
1476 selectedItem
.$element
.removeClass( 'oo-ui-element-hidden' );
1482 * MenuLayouts combine a menu and a content {@link OO.ui.PanelLayout panel}. The menu is positioned relative to the content (after, before, top, or bottom)
1483 * and its size is customized with the #menuSize config. The content area will fill all remaining space.
1486 * var menuLayout = new OO.ui.MenuLayout( {
1489 * menuPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1490 * contentPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1491 * select = new OO.ui.SelectWidget( {
1493 * new OO.ui.OptionWidget( {
1497 * new OO.ui.OptionWidget( {
1501 * new OO.ui.OptionWidget( {
1505 * new OO.ui.OptionWidget( {
1510 * } ).on( 'select', function ( item ) {
1511 * menuLayout.setMenuPosition( item.getData() );
1514 * menuLayout.$menu.append(
1515 * menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
1517 * menuLayout.$content.append(
1518 * contentPanel.$element.append( '<b>Content panel</b>', '<p>Note that the menu is positioned relative to the content panel: top, bottom, after, before.</p>')
1520 * $( 'body' ).append( menuLayout.$element );
1522 * If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
1523 * below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
1524 * menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
1527 * .oo-ui-menuLayout-menu {
1531 * .oo-ui-menuLayout-content {
1539 * @extends OO.ui.Layout
1542 * @param {Object} [config] Configuration options
1543 * @cfg {boolean} [showMenu=true] Show menu
1544 * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
1546 OO
.ui
.MenuLayout
= function OoUiMenuLayout( config
) {
1547 // Configuration initialization
1548 config
= $.extend( {
1550 menuPosition
: 'before'
1553 // Parent constructor
1554 OO
.ui
.MenuLayout
.parent
.call( this, config
);
1559 * @property {jQuery}
1561 this.$menu
= $( '<div>' );
1565 * @property {jQuery}
1567 this.$content
= $( '<div>' );
1571 .addClass( 'oo-ui-menuLayout-menu' );
1572 this.$content
.addClass( 'oo-ui-menuLayout-content' );
1574 .addClass( 'oo-ui-menuLayout' )
1575 .append( this.$content
, this.$menu
);
1576 this.setMenuPosition( config
.menuPosition
);
1577 this.toggleMenu( config
.showMenu
);
1582 OO
.inheritClass( OO
.ui
.MenuLayout
, OO
.ui
.Layout
);
1589 * @param {boolean} showMenu Show menu, omit to toggle
1592 OO
.ui
.MenuLayout
.prototype.toggleMenu = function ( showMenu
) {
1593 showMenu
= showMenu
=== undefined ? !this.showMenu
: !!showMenu
;
1595 if ( this.showMenu
!== showMenu
) {
1596 this.showMenu
= showMenu
;
1598 .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu
)
1599 .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu
);
1606 * Check if menu is visible
1608 * @return {boolean} Menu is visible
1610 OO
.ui
.MenuLayout
.prototype.isMenuVisible = function () {
1611 return this.showMenu
;
1615 * Set menu position.
1617 * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
1618 * @throws {Error} If position value is not supported
1621 OO
.ui
.MenuLayout
.prototype.setMenuPosition = function ( position
) {
1622 this.$element
.removeClass( 'oo-ui-menuLayout-' + this.menuPosition
);
1623 this.menuPosition
= position
;
1624 this.$element
.addClass( 'oo-ui-menuLayout-' + position
);
1630 * Get menu position.
1632 * @return {string} Menu position
1634 OO
.ui
.MenuLayout
.prototype.getMenuPosition = function () {
1635 return this.menuPosition
;
1639 * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
1640 * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
1641 * through the pages and select which one to display. By default, only one page is
1642 * displayed at a time and the outline is hidden. When a user navigates to a new page,
1643 * the booklet layout automatically focuses on the first focusable element, unless the
1644 * default setting is changed. Optionally, booklets can be configured to show
1645 * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
1648 * // Example of a BookletLayout that contains two PageLayouts.
1650 * function PageOneLayout( name, config ) {
1651 * PageOneLayout.parent.call( this, name, config );
1652 * this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
1654 * OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
1655 * PageOneLayout.prototype.setupOutlineItem = function () {
1656 * this.outlineItem.setLabel( 'Page One' );
1659 * function PageTwoLayout( name, config ) {
1660 * PageTwoLayout.parent.call( this, name, config );
1661 * this.$element.append( '<p>Second page</p>' );
1663 * OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
1664 * PageTwoLayout.prototype.setupOutlineItem = function () {
1665 * this.outlineItem.setLabel( 'Page Two' );
1668 * var page1 = new PageOneLayout( 'one' ),
1669 * page2 = new PageTwoLayout( 'two' );
1671 * var booklet = new OO.ui.BookletLayout( {
1675 * booklet.addPages ( [ page1, page2 ] );
1676 * $( 'body' ).append( booklet.$element );
1679 * @extends OO.ui.MenuLayout
1682 * @param {Object} [config] Configuration options
1683 * @cfg {boolean} [continuous=false] Show all pages, one after another
1684 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed.
1685 * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
1686 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
1688 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
1689 // Configuration initialization
1690 config
= config
|| {};
1692 // Parent constructor
1693 OO
.ui
.BookletLayout
.parent
.call( this, config
);
1696 this.currentPageName
= null;
1698 this.ignoreFocus
= false;
1699 this.stackLayout
= new OO
.ui
.StackLayout( { continuous
: !!config
.continuous
} );
1700 this.$content
.append( this.stackLayout
.$element
);
1701 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
1702 this.outlineVisible
= false;
1703 this.outlined
= !!config
.outlined
;
1704 if ( this.outlined
) {
1705 this.editable
= !!config
.editable
;
1706 this.outlineControlsWidget
= null;
1707 this.outlineSelectWidget
= new OO
.ui
.OutlineSelectWidget();
1708 this.outlinePanel
= new OO
.ui
.PanelLayout( { scrollable
: true } );
1709 this.$menu
.append( this.outlinePanel
.$element
);
1710 this.outlineVisible
= true;
1711 if ( this.editable
) {
1712 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
1713 this.outlineSelectWidget
1717 this.toggleMenu( this.outlined
);
1720 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
1721 if ( this.outlined
) {
1722 this.outlineSelectWidget
.connect( this, { select
: 'onOutlineSelectWidgetSelect' } );
1723 this.scrolling
= false;
1724 this.stackLayout
.connect( this, { visibleItemChange
: 'onStackLayoutVisibleItemChange' } );
1726 if ( this.autoFocus
) {
1727 // Event 'focus' does not bubble, but 'focusin' does
1728 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
1732 this.$element
.addClass( 'oo-ui-bookletLayout' );
1733 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
1734 if ( this.outlined
) {
1735 this.outlinePanel
.$element
1736 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
1737 .append( this.outlineSelectWidget
.$element
);
1738 if ( this.editable
) {
1739 this.outlinePanel
.$element
1740 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
1741 .append( this.outlineControlsWidget
.$element
);
1748 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.MenuLayout
);
1753 * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
1755 * @param {OO.ui.PageLayout} page Current page
1759 * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
1762 * @param {OO.ui.PageLayout[]} page Added pages
1763 * @param {number} index Index pages were added at
1767 * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
1768 * {@link #removePages removed} from the booklet.
1771 * @param {OO.ui.PageLayout[]} pages Removed pages
1777 * Handle stack layout focus.
1780 * @param {jQuery.Event} e Focusin event
1782 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
1785 // Find the page that an element was focused within
1786 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
1787 for ( name
in this.pages
) {
1788 // Check for page match, exclude current page to find only page changes
1789 if ( this.pages
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentPageName
) {
1790 this.setPage( name
);
1797 * Handle visibleItemChange events from the stackLayout
1799 * The next visible page is set as the current page by selecting it
1802 * @param {OO.ui.PageLayout} page The next visible page in the layout
1804 OO
.ui
.BookletLayout
.prototype.onStackLayoutVisibleItemChange = function ( page
) {
1805 // Set a flag to so that the resulting call to #onStackLayoutSet doesn't
1806 // try and scroll the item into view again.
1807 this.scrolling
= true;
1808 this.outlineSelectWidget
.selectItemByData( page
.getName() );
1809 this.scrolling
= false;
1813 * Handle stack layout set events.
1816 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
1818 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
1820 if ( !this.scrolling
&& page
) {
1821 page
.scrollElementIntoView( { complete: function () {
1822 if ( layout
.autoFocus
) {
1830 * Focus the first input in the current page.
1832 * If no page is selected, the first selectable page will be selected.
1833 * If the focus is already in an element on the current page, nothing will happen.
1834 * @param {number} [itemIndex] A specific item to focus on
1836 OO
.ui
.BookletLayout
.prototype.focus = function ( itemIndex
) {
1838 items
= this.stackLayout
.getItems();
1840 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
1841 page
= items
[ itemIndex
];
1843 page
= this.stackLayout
.getCurrentItem();
1846 if ( !page
&& this.outlined
) {
1847 this.selectFirstSelectablePage();
1848 page
= this.stackLayout
.getCurrentItem();
1853 // Only change the focus if is not already in the current page
1854 if ( !OO
.ui
.contains( page
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
1860 * Find the first focusable input in the booklet layout and focus
1863 OO
.ui
.BookletLayout
.prototype.focusFirstFocusable = function () {
1864 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
1868 * Handle outline widget select events.
1871 * @param {OO.ui.OptionWidget|null} item Selected item
1873 OO
.ui
.BookletLayout
.prototype.onOutlineSelectWidgetSelect = function ( item
) {
1875 this.setPage( item
.getData() );
1880 * Check if booklet has an outline.
1882 * @return {boolean} Booklet has an outline
1884 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
1885 return this.outlined
;
1889 * Check if booklet has editing controls.
1891 * @return {boolean} Booklet is editable
1893 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
1894 return this.editable
;
1898 * Check if booklet has a visible outline.
1900 * @return {boolean} Outline is visible
1902 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
1903 return this.outlined
&& this.outlineVisible
;
1907 * Hide or show the outline.
1909 * @param {boolean} [show] Show outline, omit to invert current state
1912 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
1913 if ( this.outlined
) {
1914 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
1915 this.outlineVisible
= show
;
1916 this.toggleMenu( show
);
1923 * Get the page closest to the specified page.
1925 * @param {OO.ui.PageLayout} page Page to use as a reference point
1926 * @return {OO.ui.PageLayout|null} Page closest to the specified page
1928 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
1929 var next
, prev
, level
,
1930 pages
= this.stackLayout
.getItems(),
1931 index
= pages
.indexOf( page
);
1933 if ( index
!== -1 ) {
1934 next
= pages
[ index
+ 1 ];
1935 prev
= pages
[ index
- 1 ];
1936 // Prefer adjacent pages at the same level
1937 if ( this.outlined
) {
1938 level
= this.outlineSelectWidget
.getItemFromData( page
.getName() ).getLevel();
1941 level
=== this.outlineSelectWidget
.getItemFromData( prev
.getName() ).getLevel()
1947 level
=== this.outlineSelectWidget
.getItemFromData( next
.getName() ).getLevel()
1953 return prev
|| next
|| null;
1957 * Get the outline widget.
1959 * If the booklet is not outlined, the method will return `null`.
1961 * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
1963 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
1964 return this.outlineSelectWidget
;
1968 * Get the outline controls widget.
1970 * If the outline is not editable, the method will return `null`.
1972 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
1974 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
1975 return this.outlineControlsWidget
;
1979 * Get a page by its symbolic name.
1981 * @param {string} name Symbolic name of page
1982 * @return {OO.ui.PageLayout|undefined} Page, if found
1984 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
1985 return this.pages
[ name
];
1989 * Get the current page.
1991 * @return {OO.ui.PageLayout|undefined} Current page, if found
1993 OO
.ui
.BookletLayout
.prototype.getCurrentPage = function () {
1994 var name
= this.getCurrentPageName();
1995 return name
? this.getPage( name
) : undefined;
1999 * Get the symbolic name of the current page.
2001 * @return {string|null} Symbolic name of the current page
2003 OO
.ui
.BookletLayout
.prototype.getCurrentPageName = function () {
2004 return this.currentPageName
;
2008 * Add pages to the booklet layout
2010 * When pages are added with the same names as existing pages, the existing pages will be
2011 * automatically removed before the new pages are added.
2013 * @param {OO.ui.PageLayout[]} pages Pages to add
2014 * @param {number} index Index of the insertion point
2018 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
2019 var i
, len
, name
, page
, item
, currentIndex
,
2020 stackLayoutPages
= this.stackLayout
.getItems(),
2024 // Remove pages with same names
2025 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2027 name
= page
.getName();
2029 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
2030 // Correct the insertion index
2031 currentIndex
= stackLayoutPages
.indexOf( this.pages
[ name
] );
2032 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2035 remove
.push( this.pages
[ name
] );
2038 if ( remove
.length
) {
2039 this.removePages( remove
);
2043 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2045 name
= page
.getName();
2046 this.pages
[ page
.getName() ] = page
;
2047 if ( this.outlined
) {
2048 item
= new OO
.ui
.OutlineOptionWidget( { data
: name
} );
2049 page
.setOutlineItem( item
);
2054 if ( this.outlined
&& items
.length
) {
2055 this.outlineSelectWidget
.addItems( items
, index
);
2056 this.selectFirstSelectablePage();
2058 this.stackLayout
.addItems( pages
, index
);
2059 this.emit( 'add', pages
, index
);
2065 * Remove the specified pages from the booklet layout.
2067 * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
2069 * @param {OO.ui.PageLayout[]} pages An array of pages to remove
2073 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
2074 var i
, len
, name
, page
,
2077 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2079 name
= page
.getName();
2080 delete this.pages
[ name
];
2081 if ( this.outlined
) {
2082 items
.push( this.outlineSelectWidget
.getItemFromData( name
) );
2083 page
.setOutlineItem( null );
2086 if ( this.outlined
&& items
.length
) {
2087 this.outlineSelectWidget
.removeItems( items
);
2088 this.selectFirstSelectablePage();
2090 this.stackLayout
.removeItems( pages
);
2091 this.emit( 'remove', pages
);
2097 * Clear all pages from the booklet layout.
2099 * To remove only a subset of pages from the booklet, use the #removePages method.
2104 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
2106 pages
= this.stackLayout
.getItems();
2109 this.currentPageName
= null;
2110 if ( this.outlined
) {
2111 this.outlineSelectWidget
.clearItems();
2112 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2113 pages
[ i
].setOutlineItem( null );
2116 this.stackLayout
.clearItems();
2118 this.emit( 'remove', pages
);
2124 * Set the current page by symbolic name.
2127 * @param {string} name Symbolic name of page
2129 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
2132 page
= this.pages
[ name
],
2133 previousPage
= this.currentPageName
&& this.pages
[ this.currentPageName
];
2135 if ( name
!== this.currentPageName
) {
2136 if ( this.outlined
) {
2137 selectedItem
= this.outlineSelectWidget
.getSelectedItem();
2138 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2139 this.outlineSelectWidget
.selectItemByData( name
);
2143 if ( previousPage
) {
2144 previousPage
.setActive( false );
2145 // Blur anything focused if the next page doesn't have anything focusable.
2146 // This is not needed if the next page has something focusable (because once it is focused
2147 // this blur happens automatically). If the layout is non-continuous, this check is
2148 // meaningless because the next page is not visible yet and thus can't hold focus.
2151 this.stackLayout
.continuous
&&
2152 OO
.ui
.findFocusable( page
.$element
).length
!== 0
2154 $focused
= previousPage
.$element
.find( ':focus' );
2155 if ( $focused
.length
) {
2156 $focused
[ 0 ].blur();
2160 this.currentPageName
= name
;
2161 page
.setActive( true );
2162 this.stackLayout
.setItem( page
);
2163 if ( !this.stackLayout
.continuous
&& previousPage
) {
2164 // This should not be necessary, since any inputs on the previous page should have been
2165 // blurred when it was hidden, but browsers are not very consistent about this.
2166 $focused
= previousPage
.$element
.find( ':focus' );
2167 if ( $focused
.length
) {
2168 $focused
[ 0 ].blur();
2171 this.emit( 'set', page
);
2177 * Select the first selectable page.
2181 OO
.ui
.BookletLayout
.prototype.selectFirstSelectablePage = function () {
2182 if ( !this.outlineSelectWidget
.getSelectedItem() ) {
2183 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.getFirstSelectableItem() );
2190 * IndexLayouts contain {@link OO.ui.CardLayout card layouts} as well as
2191 * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the cards and
2192 * select which one to display. By default, only one card is displayed at a time. When a user
2193 * navigates to a new card, the index layout automatically focuses on the first focusable element,
2194 * unless the default setting is changed.
2196 * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
2199 * // Example of a IndexLayout that contains two CardLayouts.
2201 * function CardOneLayout( name, config ) {
2202 * CardOneLayout.parent.call( this, name, config );
2203 * this.$element.append( '<p>First card</p>' );
2205 * OO.inheritClass( CardOneLayout, OO.ui.CardLayout );
2206 * CardOneLayout.prototype.setupTabItem = function () {
2207 * this.tabItem.setLabel( 'Card one' );
2210 * var card1 = new CardOneLayout( 'one' ),
2211 * card2 = new CardLayout( 'two', { label: 'Card two' } );
2213 * card2.$element.append( '<p>Second card</p>' );
2215 * var index = new OO.ui.IndexLayout();
2217 * index.addCards ( [ card1, card2 ] );
2218 * $( 'body' ).append( index.$element );
2221 * @extends OO.ui.MenuLayout
2224 * @param {Object} [config] Configuration options
2225 * @cfg {boolean} [continuous=false] Show all cards, one after another
2226 * @cfg {boolean} [expanded=true] Expand the content panel to fill the entire parent element.
2227 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new card is displayed.
2229 OO
.ui
.IndexLayout
= function OoUiIndexLayout( config
) {
2230 // Configuration initialization
2231 config
= $.extend( {}, config
, { menuPosition
: 'top' } );
2233 // Parent constructor
2234 OO
.ui
.IndexLayout
.parent
.call( this, config
);
2237 this.currentCardName
= null;
2239 this.ignoreFocus
= false;
2240 this.stackLayout
= new OO
.ui
.StackLayout( {
2241 continuous
: !!config
.continuous
,
2242 expanded
: config
.expanded
2244 this.$content
.append( this.stackLayout
.$element
);
2245 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
2247 this.tabSelectWidget
= new OO
.ui
.TabSelectWidget();
2248 this.tabPanel
= new OO
.ui
.PanelLayout();
2249 this.$menu
.append( this.tabPanel
.$element
);
2251 this.toggleMenu( true );
2254 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
2255 this.tabSelectWidget
.connect( this, { select
: 'onTabSelectWidgetSelect' } );
2256 if ( this.autoFocus
) {
2257 // Event 'focus' does not bubble, but 'focusin' does
2258 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
2262 this.$element
.addClass( 'oo-ui-indexLayout' );
2263 this.stackLayout
.$element
.addClass( 'oo-ui-indexLayout-stackLayout' );
2264 this.tabPanel
.$element
2265 .addClass( 'oo-ui-indexLayout-tabPanel' )
2266 .append( this.tabSelectWidget
.$element
);
2271 OO
.inheritClass( OO
.ui
.IndexLayout
, OO
.ui
.MenuLayout
);
2276 * A 'set' event is emitted when a card is {@link #setCard set} to be displayed by the index layout.
2278 * @param {OO.ui.CardLayout} card Current card
2282 * An 'add' event is emitted when cards are {@link #addCards added} to the index layout.
2285 * @param {OO.ui.CardLayout[]} card Added cards
2286 * @param {number} index Index cards were added at
2290 * A 'remove' event is emitted when cards are {@link #clearCards cleared} or
2291 * {@link #removeCards removed} from the index.
2294 * @param {OO.ui.CardLayout[]} cards Removed cards
2300 * Handle stack layout focus.
2303 * @param {jQuery.Event} e Focusin event
2305 OO
.ui
.IndexLayout
.prototype.onStackLayoutFocus = function ( e
) {
2308 // Find the card that an element was focused within
2309 $target
= $( e
.target
).closest( '.oo-ui-cardLayout' );
2310 for ( name
in this.cards
) {
2311 // Check for card match, exclude current card to find only card changes
2312 if ( this.cards
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentCardName
) {
2313 this.setCard( name
);
2320 * Handle stack layout set events.
2323 * @param {OO.ui.PanelLayout|null} card The card panel that is now the current panel
2325 OO
.ui
.IndexLayout
.prototype.onStackLayoutSet = function ( card
) {
2328 card
.scrollElementIntoView( { complete: function () {
2329 if ( layout
.autoFocus
) {
2337 * Focus the first input in the current card.
2339 * If no card is selected, the first selectable card will be selected.
2340 * If the focus is already in an element on the current card, nothing will happen.
2341 * @param {number} [itemIndex] A specific item to focus on
2343 OO
.ui
.IndexLayout
.prototype.focus = function ( itemIndex
) {
2345 items
= this.stackLayout
.getItems();
2347 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2348 card
= items
[ itemIndex
];
2350 card
= this.stackLayout
.getCurrentItem();
2354 this.selectFirstSelectableCard();
2355 card
= this.stackLayout
.getCurrentItem();
2360 // Only change the focus if is not already in the current page
2361 if ( !OO
.ui
.contains( card
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2367 * Find the first focusable input in the index layout and focus
2370 OO
.ui
.IndexLayout
.prototype.focusFirstFocusable = function () {
2371 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2375 * Handle tab widget select events.
2378 * @param {OO.ui.OptionWidget|null} item Selected item
2380 OO
.ui
.IndexLayout
.prototype.onTabSelectWidgetSelect = function ( item
) {
2382 this.setCard( item
.getData() );
2387 * Get the card closest to the specified card.
2389 * @param {OO.ui.CardLayout} card Card to use as a reference point
2390 * @return {OO.ui.CardLayout|null} Card closest to the specified card
2392 OO
.ui
.IndexLayout
.prototype.getClosestCard = function ( card
) {
2393 var next
, prev
, level
,
2394 cards
= this.stackLayout
.getItems(),
2395 index
= cards
.indexOf( card
);
2397 if ( index
!== -1 ) {
2398 next
= cards
[ index
+ 1 ];
2399 prev
= cards
[ index
- 1 ];
2400 // Prefer adjacent cards at the same level
2401 level
= this.tabSelectWidget
.getItemFromData( card
.getName() ).getLevel();
2404 level
=== this.tabSelectWidget
.getItemFromData( prev
.getName() ).getLevel()
2410 level
=== this.tabSelectWidget
.getItemFromData( next
.getName() ).getLevel()
2415 return prev
|| next
|| null;
2419 * Get the tabs widget.
2421 * @return {OO.ui.TabSelectWidget} Tabs widget
2423 OO
.ui
.IndexLayout
.prototype.getTabs = function () {
2424 return this.tabSelectWidget
;
2428 * Get a card by its symbolic name.
2430 * @param {string} name Symbolic name of card
2431 * @return {OO.ui.CardLayout|undefined} Card, if found
2433 OO
.ui
.IndexLayout
.prototype.getCard = function ( name
) {
2434 return this.cards
[ name
];
2438 * Get the current card.
2440 * @return {OO.ui.CardLayout|undefined} Current card, if found
2442 OO
.ui
.IndexLayout
.prototype.getCurrentCard = function () {
2443 var name
= this.getCurrentCardName();
2444 return name
? this.getCard( name
) : undefined;
2448 * Get the symbolic name of the current card.
2450 * @return {string|null} Symbolic name of the current card
2452 OO
.ui
.IndexLayout
.prototype.getCurrentCardName = function () {
2453 return this.currentCardName
;
2457 * Add cards to the index layout
2459 * When cards are added with the same names as existing cards, the existing cards will be
2460 * automatically removed before the new cards are added.
2462 * @param {OO.ui.CardLayout[]} cards Cards to add
2463 * @param {number} index Index of the insertion point
2467 OO
.ui
.IndexLayout
.prototype.addCards = function ( cards
, index
) {
2468 var i
, len
, name
, card
, item
, currentIndex
,
2469 stackLayoutCards
= this.stackLayout
.getItems(),
2473 // Remove cards with same names
2474 for ( i
= 0, len
= cards
.length
; i
< len
; i
++ ) {
2476 name
= card
.getName();
2478 if ( Object
.prototype.hasOwnProperty
.call( this.cards
, name
) ) {
2479 // Correct the insertion index
2480 currentIndex
= stackLayoutCards
.indexOf( this.cards
[ name
] );
2481 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2484 remove
.push( this.cards
[ name
] );
2487 if ( remove
.length
) {
2488 this.removeCards( remove
);
2492 for ( i
= 0, len
= cards
.length
; i
< len
; i
++ ) {
2494 name
= card
.getName();
2495 this.cards
[ card
.getName() ] = card
;
2496 item
= new OO
.ui
.TabOptionWidget( { data
: name
} );
2497 card
.setTabItem( item
);
2501 if ( items
.length
) {
2502 this.tabSelectWidget
.addItems( items
, index
);
2503 this.selectFirstSelectableCard();
2505 this.stackLayout
.addItems( cards
, index
);
2506 this.emit( 'add', cards
, index
);
2512 * Remove the specified cards from the index layout.
2514 * To remove all cards from the index, you may wish to use the #clearCards method instead.
2516 * @param {OO.ui.CardLayout[]} cards An array of cards to remove
2520 OO
.ui
.IndexLayout
.prototype.removeCards = function ( cards
) {
2521 var i
, len
, name
, card
,
2524 for ( i
= 0, len
= cards
.length
; i
< len
; i
++ ) {
2526 name
= card
.getName();
2527 delete this.cards
[ name
];
2528 items
.push( this.tabSelectWidget
.getItemFromData( name
) );
2529 card
.setTabItem( null );
2531 if ( items
.length
) {
2532 this.tabSelectWidget
.removeItems( items
);
2533 this.selectFirstSelectableCard();
2535 this.stackLayout
.removeItems( cards
);
2536 this.emit( 'remove', cards
);
2542 * Clear all cards from the index layout.
2544 * To remove only a subset of cards from the index, use the #removeCards method.
2549 OO
.ui
.IndexLayout
.prototype.clearCards = function () {
2551 cards
= this.stackLayout
.getItems();
2554 this.currentCardName
= null;
2555 this.tabSelectWidget
.clearItems();
2556 for ( i
= 0, len
= cards
.length
; i
< len
; i
++ ) {
2557 cards
[ i
].setTabItem( null );
2559 this.stackLayout
.clearItems();
2561 this.emit( 'remove', cards
);
2567 * Set the current card by symbolic name.
2570 * @param {string} name Symbolic name of card
2572 OO
.ui
.IndexLayout
.prototype.setCard = function ( name
) {
2575 card
= this.cards
[ name
],
2576 previousCard
= this.currentCardName
&& this.cards
[ this.currentCardName
];
2578 if ( name
!== this.currentCardName
) {
2579 selectedItem
= this.tabSelectWidget
.getSelectedItem();
2580 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2581 this.tabSelectWidget
.selectItemByData( name
);
2584 if ( previousCard
) {
2585 previousCard
.setActive( false );
2586 // Blur anything focused if the next card doesn't have anything focusable.
2587 // This is not needed if the next card has something focusable (because once it is focused
2588 // this blur happens automatically). If the layout is non-continuous, this check is
2589 // meaningless because the next card is not visible yet and thus can't hold focus.
2592 this.stackLayout
.continuous
&&
2593 OO
.ui
.findFocusable( card
.$element
).length
!== 0
2595 $focused
= previousCard
.$element
.find( ':focus' );
2596 if ( $focused
.length
) {
2597 $focused
[ 0 ].blur();
2601 this.currentCardName
= name
;
2602 card
.setActive( true );
2603 this.stackLayout
.setItem( card
);
2604 if ( !this.stackLayout
.continuous
&& previousCard
) {
2605 // This should not be necessary, since any inputs on the previous card should have been
2606 // blurred when it was hidden, but browsers are not very consistent about this.
2607 $focused
= previousCard
.$element
.find( ':focus' );
2608 if ( $focused
.length
) {
2609 $focused
[ 0 ].blur();
2612 this.emit( 'set', card
);
2618 * Select the first selectable card.
2622 OO
.ui
.IndexLayout
.prototype.selectFirstSelectableCard = function () {
2623 if ( !this.tabSelectWidget
.getSelectedItem() ) {
2624 this.tabSelectWidget
.selectItem( this.tabSelectWidget
.getFirstSelectableItem() );
2631 * ToggleWidget implements basic behavior of widgets with an on/off state.
2632 * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
2636 * @extends OO.ui.Widget
2639 * @param {Object} [config] Configuration options
2640 * @cfg {boolean} [value=false] The toggle’s initial on/off state.
2641 * By default, the toggle is in the 'off' state.
2643 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
2644 // Configuration initialization
2645 config
= config
|| {};
2647 // Parent constructor
2648 OO
.ui
.ToggleWidget
.parent
.call( this, config
);
2654 this.$element
.addClass( 'oo-ui-toggleWidget' );
2655 this.setValue( !!config
.value
);
2660 OO
.inheritClass( OO
.ui
.ToggleWidget
, OO
.ui
.Widget
);
2667 * A change event is emitted when the on/off state of the toggle changes.
2669 * @param {boolean} value Value representing the new state of the toggle
2675 * Get the value representing the toggle’s state.
2677 * @return {boolean} The on/off state of the toggle
2679 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
2684 * Set the state of the toggle: `true` for 'on', `false' for 'off'.
2686 * @param {boolean} value The state of the toggle
2690 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
2692 if ( this.value
!== value
) {
2694 this.emit( 'change', value
);
2695 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
2696 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
2697 this.$element
.attr( 'aria-checked', value
.toString() );
2703 * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
2704 * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
2705 * configured with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators},
2706 * {@link OO.ui.mixin.TitledElement titles}, {@link OO.ui.mixin.FlaggedElement styling flags},
2707 * and {@link OO.ui.mixin.LabelElement labels}. Please see
2708 * the [OOjs UI documentation][1] on MediaWiki for more information.
2711 * // Toggle buttons in the 'off' and 'on' state.
2712 * var toggleButton1 = new OO.ui.ToggleButtonWidget( {
2713 * label: 'Toggle Button off'
2715 * var toggleButton2 = new OO.ui.ToggleButtonWidget( {
2716 * label: 'Toggle Button on',
2719 * // Append the buttons to the DOM.
2720 * $( 'body' ).append( toggleButton1.$element, toggleButton2.$element );
2722 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#Toggle_buttons
2725 * @extends OO.ui.ToggleWidget
2726 * @mixins OO.ui.mixin.ButtonElement
2727 * @mixins OO.ui.mixin.IconElement
2728 * @mixins OO.ui.mixin.IndicatorElement
2729 * @mixins OO.ui.mixin.LabelElement
2730 * @mixins OO.ui.mixin.TitledElement
2731 * @mixins OO.ui.mixin.FlaggedElement
2732 * @mixins OO.ui.mixin.TabIndexedElement
2735 * @param {Object} [config] Configuration options
2736 * @cfg {boolean} [value=false] The toggle button’s initial on/off
2737 * state. By default, the button is in the 'off' state.
2739 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
2740 // Configuration initialization
2741 config
= config
|| {};
2743 // Parent constructor
2744 OO
.ui
.ToggleButtonWidget
.parent
.call( this, config
);
2746 // Mixin constructors
2747 OO
.ui
.mixin
.ButtonElement
.call( this, config
);
2748 OO
.ui
.mixin
.IconElement
.call( this, config
);
2749 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
2750 OO
.ui
.mixin
.LabelElement
.call( this, config
);
2751 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
2752 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
2753 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$button
} ) );
2756 this.connect( this, { click
: 'onAction' } );
2759 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
2761 .addClass( 'oo-ui-toggleButtonWidget' )
2762 .append( this.$button
);
2767 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
2768 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.ButtonElement
);
2769 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IconElement
);
2770 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IndicatorElement
);
2771 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.LabelElement
);
2772 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TitledElement
);
2773 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.FlaggedElement
);
2774 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2779 * Handle the button action being triggered.
2783 OO
.ui
.ToggleButtonWidget
.prototype.onAction = function () {
2784 this.setValue( !this.value
);
2790 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
2792 if ( value
!== this.value
) {
2793 // Might be called from parent constructor before ButtonElement constructor
2794 if ( this.$button
) {
2795 this.$button
.attr( 'aria-pressed', value
.toString() );
2797 this.setActive( value
);
2801 OO
.ui
.ToggleButtonWidget
.parent
.prototype.setValue
.call( this, value
);
2809 OO
.ui
.ToggleButtonWidget
.prototype.setButtonElement = function ( $button
) {
2810 if ( this.$button
) {
2811 this.$button
.removeAttr( 'aria-pressed' );
2813 OO
.ui
.mixin
.ButtonElement
.prototype.setButtonElement
.call( this, $button
);
2814 this.$button
.attr( 'aria-pressed', this.value
.toString() );
2818 * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
2819 * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
2820 * visually by a slider in the leftmost position.
2823 * // Toggle switches in the 'off' and 'on' position.
2824 * var toggleSwitch1 = new OO.ui.ToggleSwitchWidget();
2825 * var toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
2829 * // Create a FieldsetLayout to layout and label switches
2830 * var fieldset = new OO.ui.FieldsetLayout( {
2831 * label: 'Toggle switches'
2833 * fieldset.addItems( [
2834 * new OO.ui.FieldLayout( toggleSwitch1, { label: 'Off', align: 'top' } ),
2835 * new OO.ui.FieldLayout( toggleSwitch2, { label: 'On', align: 'top' } )
2837 * $( 'body' ).append( fieldset.$element );
2840 * @extends OO.ui.ToggleWidget
2841 * @mixins OO.ui.mixin.TabIndexedElement
2844 * @param {Object} [config] Configuration options
2845 * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
2846 * By default, the toggle switch is in the 'off' position.
2848 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
2849 // Parent constructor
2850 OO
.ui
.ToggleSwitchWidget
.parent
.call( this, config
);
2852 // Mixin constructors
2853 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
2856 this.dragging
= false;
2857 this.dragStart
= null;
2858 this.sliding
= false;
2859 this.$glow
= $( '<span>' );
2860 this.$grip
= $( '<span>' );
2864 click
: this.onClick
.bind( this ),
2865 keypress
: this.onKeyPress
.bind( this )
2869 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
2870 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
2872 .addClass( 'oo-ui-toggleSwitchWidget' )
2873 .attr( 'role', 'checkbox' )
2874 .append( this.$glow
, this.$grip
);
2879 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
2880 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2885 * Handle mouse click events.
2888 * @param {jQuery.Event} e Mouse click event
2890 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
2891 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
2892 this.setValue( !this.value
);
2898 * Handle key press events.
2901 * @param {jQuery.Event} e Key press event
2903 OO
.ui
.ToggleSwitchWidget
.prototype.onKeyPress = function ( e
) {
2904 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
2905 this.setValue( !this.value
);
2911 * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
2912 * Controls include moving items up and down, removing items, and adding different kinds of items.
2914 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
2917 * @extends OO.ui.Widget
2918 * @mixins OO.ui.mixin.GroupElement
2919 * @mixins OO.ui.mixin.IconElement
2922 * @param {OO.ui.OutlineSelectWidget} outline Outline to control
2923 * @param {Object} [config] Configuration options
2924 * @cfg {Object} [abilities] List of abilties
2925 * @cfg {boolean} [abilities.move=true] Allow moving movable items
2926 * @cfg {boolean} [abilities.remove=true] Allow removing removable items
2928 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
2929 // Allow passing positional parameters inside the config object
2930 if ( OO
.isPlainObject( outline
) && config
=== undefined ) {
2932 outline
= config
.outline
;
2935 // Configuration initialization
2936 config
= $.extend( { icon
: 'add' }, config
);
2938 // Parent constructor
2939 OO
.ui
.OutlineControlsWidget
.parent
.call( this, config
);
2941 // Mixin constructors
2942 OO
.ui
.mixin
.GroupElement
.call( this, config
);
2943 OO
.ui
.mixin
.IconElement
.call( this, config
);
2946 this.outline
= outline
;
2947 this.$movers
= $( '<div>' );
2948 this.upButton
= new OO
.ui
.ButtonWidget( {
2951 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
2953 this.downButton
= new OO
.ui
.ButtonWidget( {
2956 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
2958 this.removeButton
= new OO
.ui
.ButtonWidget( {
2961 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
2963 this.abilities
= { move: true, remove
: true };
2966 outline
.connect( this, {
2967 select
: 'onOutlineChange',
2968 add
: 'onOutlineChange',
2969 remove
: 'onOutlineChange'
2971 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
2972 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
2973 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
2976 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
2977 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
2979 .addClass( 'oo-ui-outlineControlsWidget-movers' )
2980 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
2981 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
2982 this.setAbilities( config
.abilities
|| {} );
2987 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
2988 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.GroupElement
);
2989 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.IconElement
);
2995 * @param {number} places Number of places to move
3007 * @param {Object} abilities List of abilties
3008 * @param {boolean} [abilities.move] Allow moving movable items
3009 * @param {boolean} [abilities.remove] Allow removing removable items
3011 OO
.ui
.OutlineControlsWidget
.prototype.setAbilities = function ( abilities
) {
3014 for ( ability
in this.abilities
) {
3015 if ( abilities
[ ability
] !== undefined ) {
3016 this.abilities
[ ability
] = !!abilities
[ ability
];
3020 this.onOutlineChange();
3025 * Handle outline change events.
3027 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
3028 var i
, len
, firstMovable
, lastMovable
,
3029 items
= this.outline
.getItems(),
3030 selectedItem
= this.outline
.getSelectedItem(),
3031 movable
= this.abilities
.move && selectedItem
&& selectedItem
.isMovable(),
3032 removable
= this.abilities
.remove
&& selectedItem
&& selectedItem
.isRemovable();
3037 while ( ++i
< len
) {
3038 if ( items
[ i
].isMovable() ) {
3039 firstMovable
= items
[ i
];
3045 if ( items
[ i
].isMovable() ) {
3046 lastMovable
= items
[ i
];
3051 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
3052 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
3053 this.removeButton
.setDisabled( !removable
);
3057 * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
3059 * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
3060 * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
3064 * @extends OO.ui.DecoratedOptionWidget
3067 * @param {Object} [config] Configuration options
3068 * @cfg {number} [level] Indentation level
3069 * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
3071 OO
.ui
.OutlineOptionWidget
= function OoUiOutlineOptionWidget( config
) {
3072 // Configuration initialization
3073 config
= config
|| {};
3075 // Parent constructor
3076 OO
.ui
.OutlineOptionWidget
.parent
.call( this, config
);
3080 this.movable
= !!config
.movable
;
3081 this.removable
= !!config
.removable
;
3084 this.$element
.addClass( 'oo-ui-outlineOptionWidget' );
3085 this.setLevel( config
.level
);
3090 OO
.inheritClass( OO
.ui
.OutlineOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
3092 /* Static Properties */
3094 OO
.ui
.OutlineOptionWidget
.static.highlightable
= false;
3096 OO
.ui
.OutlineOptionWidget
.static.scrollIntoViewOnSelect
= true;
3098 OO
.ui
.OutlineOptionWidget
.static.levelClass
= 'oo-ui-outlineOptionWidget-level-';
3100 OO
.ui
.OutlineOptionWidget
.static.levels
= 3;
3105 * Check if item is movable.
3107 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3109 * @return {boolean} Item is movable
3111 OO
.ui
.OutlineOptionWidget
.prototype.isMovable = function () {
3112 return this.movable
;
3116 * Check if item is removable.
3118 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3120 * @return {boolean} Item is removable
3122 OO
.ui
.OutlineOptionWidget
.prototype.isRemovable = function () {
3123 return this.removable
;
3127 * Get indentation level.
3129 * @return {number} Indentation level
3131 OO
.ui
.OutlineOptionWidget
.prototype.getLevel = function () {
3138 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3140 * @param {boolean} movable Item is movable
3143 OO
.ui
.OutlineOptionWidget
.prototype.setMovable = function ( movable
) {
3144 this.movable
= !!movable
;
3145 this.updateThemeClasses();
3152 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3154 * @param {boolean} removable Item is removable
3157 OO
.ui
.OutlineOptionWidget
.prototype.setRemovable = function ( removable
) {
3158 this.removable
= !!removable
;
3159 this.updateThemeClasses();
3164 * Set indentation level.
3166 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
3169 OO
.ui
.OutlineOptionWidget
.prototype.setLevel = function ( level
) {
3170 var levels
= this.constructor.static.levels
,
3171 levelClass
= this.constructor.static.levelClass
,
3174 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
3176 if ( this.level
=== i
) {
3177 this.$element
.addClass( levelClass
+ i
);
3179 this.$element
.removeClass( levelClass
+ i
);
3182 this.updateThemeClasses();
3188 * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
3189 * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
3191 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3194 * @extends OO.ui.SelectWidget
3195 * @mixins OO.ui.mixin.TabIndexedElement
3198 * @param {Object} [config] Configuration options
3200 OO
.ui
.OutlineSelectWidget
= function OoUiOutlineSelectWidget( config
) {
3201 // Parent constructor
3202 OO
.ui
.OutlineSelectWidget
.parent
.call( this, config
);
3204 // Mixin constructors
3205 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3209 focus
: this.bindKeyDownListener
.bind( this ),
3210 blur
: this.unbindKeyDownListener
.bind( this )
3214 this.$element
.addClass( 'oo-ui-outlineSelectWidget' );
3219 OO
.inheritClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.SelectWidget
);
3220 OO
.mixinClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3223 * ButtonOptionWidget is a special type of {@link OO.ui.mixin.ButtonElement button element} that
3224 * can be selected and configured with data. The class is
3225 * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
3226 * [OOjs UI documentation on MediaWiki] [1] for more information.
3228 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Button_selects_and_options
3231 * @extends OO.ui.DecoratedOptionWidget
3232 * @mixins OO.ui.mixin.ButtonElement
3233 * @mixins OO.ui.mixin.TabIndexedElement
3234 * @mixins OO.ui.mixin.TitledElement
3237 * @param {Object} [config] Configuration options
3239 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( config
) {
3240 // Configuration initialization
3241 config
= config
|| {};
3243 // Parent constructor
3244 OO
.ui
.ButtonOptionWidget
.parent
.call( this, config
);
3246 // Mixin constructors
3247 OO
.ui
.mixin
.ButtonElement
.call( this, config
);
3248 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
3249 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, {
3250 $tabIndexed
: this.$button
,
3255 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
3256 this.$button
.append( this.$element
.contents() );
3257 this.$element
.append( this.$button
);
3262 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
3263 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.ButtonElement
);
3264 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.TitledElement
);
3265 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3267 /* Static Properties */
3269 // Allow button mouse down events to pass through so they can be handled by the parent select widget
3270 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
3272 OO
.ui
.ButtonOptionWidget
.static.highlightable
= false;
3279 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
3280 OO
.ui
.ButtonOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3282 if ( this.constructor.static.selectable
) {
3283 this.setActive( state
);
3290 * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
3291 * button options and is used together with
3292 * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
3293 * highlighting, choosing, and selecting mutually exclusive options. Please see
3294 * the [OOjs UI documentation on MediaWiki] [1] for more information.
3297 * // Example: A ButtonSelectWidget that contains three ButtonOptionWidgets
3298 * var option1 = new OO.ui.ButtonOptionWidget( {
3300 * label: 'Option 1',
3301 * title: 'Button option 1'
3304 * var option2 = new OO.ui.ButtonOptionWidget( {
3306 * label: 'Option 2',
3307 * title: 'Button option 2'
3310 * var option3 = new OO.ui.ButtonOptionWidget( {
3312 * label: 'Option 3',
3313 * title: 'Button option 3'
3316 * var buttonSelect=new OO.ui.ButtonSelectWidget( {
3317 * items: [ option1, option2, option3 ]
3319 * $( 'body' ).append( buttonSelect.$element );
3321 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
3324 * @extends OO.ui.SelectWidget
3325 * @mixins OO.ui.mixin.TabIndexedElement
3328 * @param {Object} [config] Configuration options
3330 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
3331 // Parent constructor
3332 OO
.ui
.ButtonSelectWidget
.parent
.call( this, config
);
3334 // Mixin constructors
3335 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3339 focus
: this.bindKeyDownListener
.bind( this ),
3340 blur
: this.unbindKeyDownListener
.bind( this )
3344 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
3349 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
3350 OO
.mixinClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3353 * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
3355 * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
3356 * {@link OO.ui.CardLayout card layouts}. See {@link OO.ui.IndexLayout IndexLayout}
3360 * @extends OO.ui.OptionWidget
3363 * @param {Object} [config] Configuration options
3365 OO
.ui
.TabOptionWidget
= function OoUiTabOptionWidget( config
) {
3366 // Configuration initialization
3367 config
= config
|| {};
3369 // Parent constructor
3370 OO
.ui
.TabOptionWidget
.parent
.call( this, config
);
3373 this.$element
.addClass( 'oo-ui-tabOptionWidget' );
3378 OO
.inheritClass( OO
.ui
.TabOptionWidget
, OO
.ui
.OptionWidget
);
3380 /* Static Properties */
3382 OO
.ui
.TabOptionWidget
.static.highlightable
= false;
3385 * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
3387 * **Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.**
3390 * @extends OO.ui.SelectWidget
3391 * @mixins OO.ui.mixin.TabIndexedElement
3394 * @param {Object} [config] Configuration options
3396 OO
.ui
.TabSelectWidget
= function OoUiTabSelectWidget( config
) {
3397 // Parent constructor
3398 OO
.ui
.TabSelectWidget
.parent
.call( this, config
);
3400 // Mixin constructors
3401 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3405 focus
: this.bindKeyDownListener
.bind( this ),
3406 blur
: this.unbindKeyDownListener
.bind( this )
3410 this.$element
.addClass( 'oo-ui-tabSelectWidget' );
3415 OO
.inheritClass( OO
.ui
.TabSelectWidget
, OO
.ui
.SelectWidget
);
3416 OO
.mixinClass( OO
.ui
.TabSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3419 * CapsuleItemWidgets are used within a {@link OO.ui.CapsuleMultiSelectWidget
3420 * CapsuleMultiSelectWidget} to display the selected items.
3423 * @extends OO.ui.Widget
3424 * @mixins OO.ui.mixin.ItemWidget
3425 * @mixins OO.ui.mixin.LabelElement
3426 * @mixins OO.ui.mixin.FlaggedElement
3427 * @mixins OO.ui.mixin.TabIndexedElement
3430 * @param {Object} [config] Configuration options
3432 OO
.ui
.CapsuleItemWidget
= function OoUiCapsuleItemWidget( config
) {
3433 // Configuration initialization
3434 config
= config
|| {};
3436 // Parent constructor
3437 OO
.ui
.CapsuleItemWidget
.parent
.call( this, config
);
3439 // Mixin constructors
3440 OO
.ui
.mixin
.ItemWidget
.call( this );
3441 OO
.ui
.mixin
.LabelElement
.call( this, config
);
3442 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3443 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3446 this.closeButton
= new OO
.ui
.ButtonWidget( {
3450 } ).on( 'click', this.onCloseClick
.bind( this ) );
3452 this.on( 'disable', function ( disabled
) {
3453 this.closeButton
.setDisabled( disabled
);
3459 click
: this.onClick
.bind( this ),
3460 keydown
: this.onKeyDown
.bind( this )
3462 .addClass( 'oo-ui-capsuleItemWidget' )
3463 .append( this.$label
, this.closeButton
.$element
);
3468 OO
.inheritClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.Widget
);
3469 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.ItemWidget
);
3470 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.LabelElement
);
3471 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
3472 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3477 * Handle close icon clicks
3479 OO
.ui
.CapsuleItemWidget
.prototype.onCloseClick = function () {
3480 var element
= this.getElementGroup();
3482 if ( element
&& $.isFunction( element
.removeItems
) ) {
3483 element
.removeItems( [ this ] );
3489 * Handle click event for the entire capsule
3491 OO
.ui
.CapsuleItemWidget
.prototype.onClick = function () {
3492 var element
= this.getElementGroup();
3494 if ( !this.isDisabled() && element
&& $.isFunction( element
.editItem
) ) {
3495 element
.editItem( this );
3500 * Handle keyDown event for the entire capsule
3502 OO
.ui
.CapsuleItemWidget
.prototype.onKeyDown = function ( e
) {
3503 var element
= this.getElementGroup();
3505 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
3506 element
.removeItems( [ this ] );
3509 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
3510 element
.editItem( this );
3512 } else if ( e
.keyCode
=== OO
.ui
.Keys
.LEFT
) {
3513 element
.getPreviousItem( this ).focus();
3514 } else if ( e
.keyCode
=== OO
.ui
.Keys
.RIGHT
) {
3515 element
.getNextItem( this ).focus();
3520 * Focuses the capsule
3522 OO
.ui
.CapsuleItemWidget
.prototype.focus = function () {
3523 this.$element
.focus();
3527 * CapsuleMultiSelectWidgets are something like a {@link OO.ui.ComboBoxInputWidget combo box widget}
3528 * that allows for selecting multiple values.
3530 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
3533 * // Example: A CapsuleMultiSelectWidget.
3534 * var capsule = new OO.ui.CapsuleMultiSelectWidget( {
3535 * label: 'CapsuleMultiSelectWidget',
3536 * selected: [ 'Option 1', 'Option 3' ],
3539 * new OO.ui.MenuOptionWidget( {
3541 * label: 'Option One'
3543 * new OO.ui.MenuOptionWidget( {
3545 * label: 'Option Two'
3547 * new OO.ui.MenuOptionWidget( {
3549 * label: 'Option Three'
3551 * new OO.ui.MenuOptionWidget( {
3553 * label: 'Option Four'
3555 * new OO.ui.MenuOptionWidget( {
3557 * label: 'Option Five'
3562 * $( 'body' ).append( capsule.$element );
3564 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
3567 * @extends OO.ui.Widget
3568 * @mixins OO.ui.mixin.TabIndexedElement
3569 * @mixins OO.ui.mixin.GroupElement
3570 * @uses OO.ui.CapsuleItemWidget
3571 * @uses OO.ui.FloatingMenuSelectWidget
3574 * @param {Object} [config] Configuration options
3575 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if not present in the menu.
3576 * @cfg {Object} [menu] (required) Configuration options to pass to the
3577 * {@link OO.ui.MenuSelectWidget menu select widget}.
3578 * @cfg {Object} [popup] Configuration options to pass to the {@link OO.ui.PopupWidget popup widget}.
3579 * If specified, this popup will be shown instead of the menu (but the menu
3580 * will still be used for item labels and allowArbitrary=false). The widgets
3581 * in the popup should use {@link #addItemsFromData} or {@link #addItems} as necessary.
3582 * @cfg {jQuery} [$overlay=this.$element] Render the menu or popup into a separate layer.
3583 * This configuration is useful in cases where the expanded menu is larger than
3584 * its containing `<div>`. The specified overlay layer is usually on top of
3585 * the containing `<div>` and has a larger area. By default, the menu uses
3586 * relative positioning.
3588 OO
.ui
.CapsuleMultiSelectWidget
= function OoUiCapsuleMultiSelectWidget( config
) {
3591 // Parent constructor
3592 OO
.ui
.CapsuleMultiSelectWidget
.parent
.call( this, config
);
3594 // Configuration initialization
3595 config
= $.extend( {
3596 allowArbitrary
: false,
3597 $overlay
: this.$element
3600 // Properties (must be set before mixin constructor calls)
3601 this.$input
= config
.popup
? null : $( '<input>' );
3602 this.$handle
= $( '<div>' );
3604 // Mixin constructors
3605 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3606 if ( config
.popup
) {
3607 config
.popup
= $.extend( {}, config
.popup
, {
3611 OO
.ui
.mixin
.PopupElement
.call( this, config
);
3612 $tabFocus
= $( '<span>' );
3613 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: $tabFocus
} ) );
3617 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$input
} ) );
3619 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3620 OO
.ui
.mixin
.IconElement
.call( this, config
);
3623 this.$content
= $( '<div>' );
3624 this.allowArbitrary
= config
.allowArbitrary
;
3625 this.$overlay
= config
.$overlay
;
3626 this.menu
= new OO
.ui
.FloatingMenuSelectWidget( $.extend(
3629 $input
: this.$input
,
3630 $container
: this.$element
,
3631 filterFromInput
: true,
3632 disabled
: this.isDisabled()
3640 focus
: this.onFocusForPopup
.bind( this )
3642 this.popup
.$element
.on( 'focusout', this.onPopupFocusOut
.bind( this ) );
3643 if ( this.popup
.$autoCloseIgnore
) {
3644 this.popup
.$autoCloseIgnore
.on( 'focusout', this.onPopupFocusOut
.bind( this ) );
3646 this.popup
.connect( this, {
3647 toggle: function ( visible
) {
3648 $tabFocus
.toggle( !visible
);
3653 focus
: this.onInputFocus
.bind( this ),
3654 blur
: this.onInputBlur
.bind( this ),
3655 'propertychange change click mouseup keydown keyup input cut paste select focus':
3656 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
3657 keydown
: this.onKeyDown
.bind( this ),
3658 keypress
: this.onKeyPress
.bind( this )
3661 this.menu
.connect( this, {
3662 choose
: 'onMenuChoose',
3663 add
: 'onMenuItemsChange',
3664 remove
: 'onMenuItemsChange'
3667 mousedown
: this.onMouseDown
.bind( this )
3671 if ( this.$input
) {
3672 this.$input
.prop( 'disabled', this.isDisabled() );
3675 'aria-autocomplete': 'list'
3677 this.updateInputSize();
3679 if ( config
.data
) {
3680 this.setItemsFromData( config
.data
);
3682 this.$content
.addClass( 'oo-ui-capsuleMultiSelectWidget-content' )
3683 .append( this.$group
);
3684 this.$group
.addClass( 'oo-ui-capsuleMultiSelectWidget-group' );
3685 this.$handle
.addClass( 'oo-ui-capsuleMultiSelectWidget-handle' )
3686 .append( this.$indicator
, this.$icon
, this.$content
);
3687 this.$element
.addClass( 'oo-ui-capsuleMultiSelectWidget' )
3688 .append( this.$handle
);
3690 this.$content
.append( $tabFocus
);
3691 this.$overlay
.append( this.popup
.$element
);
3693 this.$content
.append( this.$input
);
3694 this.$overlay
.append( this.menu
.$element
);
3696 this.onMenuItemsChange();
3701 OO
.inheritClass( OO
.ui
.CapsuleMultiSelectWidget
, OO
.ui
.Widget
);
3702 OO
.mixinClass( OO
.ui
.CapsuleMultiSelectWidget
, OO
.ui
.mixin
.GroupElement
);
3703 OO
.mixinClass( OO
.ui
.CapsuleMultiSelectWidget
, OO
.ui
.mixin
.PopupElement
);
3704 OO
.mixinClass( OO
.ui
.CapsuleMultiSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3705 OO
.mixinClass( OO
.ui
.CapsuleMultiSelectWidget
, OO
.ui
.mixin
.IndicatorElement
);
3706 OO
.mixinClass( OO
.ui
.CapsuleMultiSelectWidget
, OO
.ui
.mixin
.IconElement
);
3713 * A change event is emitted when the set of selected items changes.
3715 * @param {Mixed[]} datas Data of the now-selected items
3721 * Construct a OO.ui.CapsuleItemWidget (or a subclass thereof) from given label and data.
3724 * @param {Mixed} data Custom data of any type.
3725 * @param {string} label The label text.
3726 * @return {OO.ui.CapsuleItemWidget}
3728 OO
.ui
.CapsuleMultiSelectWidget
.prototype.createItemWidget = function ( data
, label
) {
3729 return new OO
.ui
.CapsuleItemWidget( { data
: data
, label
: label
} );
3733 * Get the data of the items in the capsule
3736 OO
.ui
.CapsuleMultiSelectWidget
.prototype.getItemsData = function () {
3737 return $.map( this.getItems(), function ( e
) { return e
.data
; } );
3741 * Set the items in the capsule by providing data
3743 * @param {Mixed[]} datas
3744 * @return {OO.ui.CapsuleMultiSelectWidget}
3746 OO
.ui
.CapsuleMultiSelectWidget
.prototype.setItemsFromData = function ( datas
) {
3749 items
= this.getItems();
3751 $.each( datas
, function ( i
, data
) {
3753 item
= menu
.getItemFromData( data
);
3757 } else if ( widget
.allowArbitrary
) {
3758 label
= String( data
);
3764 for ( j
= 0; j
< items
.length
; j
++ ) {
3765 if ( items
[ j
].data
=== data
&& items
[ j
].label
=== label
) {
3767 items
.splice( j
, 1 );
3772 item
= widget
.createItemWidget( data
, label
);
3774 widget
.addItems( [ item
], i
);
3777 if ( items
.length
) {
3778 widget
.removeItems( items
);
3785 * Add items to the capsule by providing their data
3787 * @param {Mixed[]} datas
3788 * @return {OO.ui.CapsuleMultiSelectWidget}
3790 OO
.ui
.CapsuleMultiSelectWidget
.prototype.addItemsFromData = function ( datas
) {
3795 $.each( datas
, function ( i
, data
) {
3798 if ( !widget
.getItemFromData( data
) ) {
3799 item
= menu
.getItemFromData( data
);
3801 items
.push( widget
.createItemWidget( data
, item
.label
) );
3802 } else if ( widget
.allowArbitrary
) {
3803 items
.push( widget
.createItemWidget( data
, String( data
) ) );
3808 if ( items
.length
) {
3809 this.addItems( items
);
3816 * Add items to the capsule by providing a label
3817 * @param {string} label
3818 * @return {boolean} Whether the item was added or not
3820 OO
.ui
.CapsuleMultiSelectWidget
.prototype.addItemFromLabel = function ( label
) {
3821 var item
= this.menu
.getItemFromLabel( label
, true );
3823 this.addItemsFromData( [ item
.data
] );
3825 } else if ( this.allowArbitrary
&& this.$input
.val().trim() !== '' ) {
3826 this.addItemsFromData( [ label
] );
3833 * Remove items by data
3835 * @param {Mixed[]} datas
3836 * @return {OO.ui.CapsuleMultiSelectWidget}
3838 OO
.ui
.CapsuleMultiSelectWidget
.prototype.removeItemsFromData = function ( datas
) {
3842 $.each( datas
, function ( i
, data
) {
3843 var item
= widget
.getItemFromData( data
);
3849 if ( items
.length
) {
3850 this.removeItems( items
);
3859 OO
.ui
.CapsuleMultiSelectWidget
.prototype.addItems = function ( items
) {
3861 oldItems
= this.items
.slice();
3863 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
);
3865 if ( this.items
.length
!== oldItems
.length
) {
3869 for ( i
= 0, l
= oldItems
.length
; same
&& i
< l
; i
++ ) {
3870 same
= same
&& this.items
[ i
] === oldItems
[ i
];
3874 this.emit( 'change', this.getItemsData() );
3875 this.menu
.position();
3882 * Removes the item from the list and copies its label to `this.$input`.
3884 * @param {Object} item
3886 OO
.ui
.CapsuleMultiSelectWidget
.prototype.editItem = function ( item
) {
3887 this.$input
.val( item
.label
);
3888 this.updateInputSize();
3890 this.removeItems( [ item
] );
3896 OO
.ui
.CapsuleMultiSelectWidget
.prototype.removeItems = function ( items
) {
3898 oldItems
= this.items
.slice();
3900 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
3902 if ( this.items
.length
!== oldItems
.length
) {
3906 for ( i
= 0, l
= oldItems
.length
; same
&& i
< l
; i
++ ) {
3907 same
= same
&& this.items
[ i
] === oldItems
[ i
];
3911 this.emit( 'change', this.getItemsData() );
3912 this.menu
.position();
3921 OO
.ui
.CapsuleMultiSelectWidget
.prototype.clearItems = function () {
3922 if ( this.items
.length
) {
3923 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
3924 this.emit( 'change', this.getItemsData() );
3925 this.menu
.position();
3931 * Given an item, returns the item after it. If its the last item,
3932 * returns `this.$input`. If no item is passed, returns the very first
3935 * @param {OO.ui.CapsuleItemWidget} [item]
3936 * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
3938 OO
.ui
.CapsuleMultiSelectWidget
.prototype.getNextItem = function ( item
) {
3941 if ( item
=== undefined ) {
3942 return this.items
[ 0 ];
3945 itemIndex
= this.items
.indexOf( item
);
3946 if ( itemIndex
< 0 ) { // Item not in list
3948 } else if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
3951 return this.items
[ itemIndex
+ 1 ];
3956 * Given an item, returns the item before it. If its the first item,
3957 * returns `this.$input`. If no item is passed, returns the very last
3960 * @param {OO.ui.CapsuleItemWidget} [item]
3961 * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
3963 OO
.ui
.CapsuleMultiSelectWidget
.prototype.getPreviousItem = function ( item
) {
3966 if ( item
=== undefined ) {
3967 return this.items
[ this.items
.length
- 1 ];
3970 itemIndex
= this.items
.indexOf( item
);
3971 if ( itemIndex
< 0 ) { // Item not in list
3973 } else if ( itemIndex
=== 0 ) { // First item
3976 return this.items
[ itemIndex
- 1 ];
3981 * Get the capsule widget's menu.
3982 * @return {OO.ui.MenuSelectWidget} Menu widget
3984 OO
.ui
.CapsuleMultiSelectWidget
.prototype.getMenu = function () {
3989 * Handle focus events
3992 * @param {jQuery.Event} event
3994 OO
.ui
.CapsuleMultiSelectWidget
.prototype.onInputFocus = function () {
3995 if ( !this.isDisabled() ) {
3996 this.menu
.toggle( true );
4001 * Handle blur events
4004 * @param {jQuery.Event} event
4006 OO
.ui
.CapsuleMultiSelectWidget
.prototype.onInputBlur = function () {
4007 this.addItemFromLabel( this.$input
.val() );
4012 * Handle focus events
4015 * @param {jQuery.Event} event
4017 OO
.ui
.CapsuleMultiSelectWidget
.prototype.onFocusForPopup = function () {
4018 if ( !this.isDisabled() ) {
4019 this.popup
.setSize( this.$handle
.width() );
4020 this.popup
.toggle( true );
4021 this.popup
.$element
.find( '*' )
4022 .filter( function () { return OO
.ui
.isFocusableElement( $( this ), true ); } )
4029 * Handles popup focus out events.
4032 * @param {jQuery.Event} e Focus out event
4034 OO
.ui
.CapsuleMultiSelectWidget
.prototype.onPopupFocusOut = function () {
4035 var widget
= this.popup
;
4037 setTimeout( function () {
4039 widget
.isVisible() &&
4040 !OO
.ui
.contains( widget
.$element
[ 0 ], document
.activeElement
, true ) &&
4041 ( !widget
.$autoCloseIgnore
|| !widget
.$autoCloseIgnore
.has( document
.activeElement
).length
)
4043 widget
.toggle( false );
4049 * Handle mouse down events.
4052 * @param {jQuery.Event} e Mouse down event
4054 OO
.ui
.CapsuleMultiSelectWidget
.prototype.onMouseDown = function ( e
) {
4055 if ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
4059 this.updateInputSize();
4064 * Handle key press events.
4067 * @param {jQuery.Event} e Key press event
4069 OO
.ui
.CapsuleMultiSelectWidget
.prototype.onKeyPress = function ( e
) {
4070 if ( !this.isDisabled() ) {
4071 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
4076 if ( !this.popup
) {
4077 this.menu
.toggle( true );
4078 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4079 if ( this.addItemFromLabel( this.$input
.val() ) ) {
4085 // Make sure the input gets resized.
4086 setTimeout( this.updateInputSize
.bind( this ), 0 );
4092 * Handle key down events.
4095 * @param {jQuery.Event} e Key down event
4097 OO
.ui
.CapsuleMultiSelectWidget
.prototype.onKeyDown = function ( e
) {
4099 !this.isDisabled() &&
4100 this.$input
.val() === '' &&
4103 // 'keypress' event is not triggered for Backspace
4104 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
4105 if ( e
.metaKey
|| e
.ctrlKey
) {
4106 this.removeItems( this.items
.slice( -1 ) );
4108 this.editItem( this.items
[ this.items
.length
- 1 ] );
4111 } else if ( e
.keyCode
=== OO
.ui
.Keys
.LEFT
) {
4112 this.getPreviousItem().focus();
4113 } else if ( e
.keyCode
=== OO
.ui
.Keys
.RIGHT
) {
4114 this.getNextItem().focus();
4120 * Update the dimensions of the text input field to encompass all available area.
4123 * @param {jQuery.Event} e Event of some sort
4125 OO
.ui
.CapsuleMultiSelectWidget
.prototype.updateInputSize = function () {
4126 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
4127 if ( !this.isDisabled() ) {
4128 this.$input
.css( 'width', '1em' );
4129 $lastItem
= this.$group
.children().last();
4130 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
4131 contentWidth
= this.$input
[ 0 ].scrollWidth
;
4132 currentWidth
= this.$input
.width();
4134 if ( contentWidth
< currentWidth
) {
4135 // All is fine, don't perform expensive calculations
4139 if ( !$lastItem
.length
) {
4140 bestWidth
= this.$content
.innerWidth();
4142 bestWidth
= direction
=== 'ltr' ?
4143 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
4144 $lastItem
.position().left
;
4146 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
4147 // pixels this is off by are coming from.
4149 if ( contentWidth
> bestWidth
) {
4150 // This will result in the input getting shifted to the next line
4151 bestWidth
= this.$content
.innerWidth() - 10;
4153 this.$input
.width( Math
.floor( bestWidth
) );
4155 this.menu
.position();
4160 * Handle menu choose events.
4163 * @param {OO.ui.OptionWidget} item Chosen item
4165 OO
.ui
.CapsuleMultiSelectWidget
.prototype.onMenuChoose = function ( item
) {
4166 if ( item
&& item
.isVisible() ) {
4167 this.addItemsFromData( [ item
.getData() ] );
4173 * Handle menu item change events.
4177 OO
.ui
.CapsuleMultiSelectWidget
.prototype.onMenuItemsChange = function () {
4178 this.setItemsFromData( this.getItemsData() );
4179 this.$element
.toggleClass( 'oo-ui-capsuleMultiSelectWidget-empty', this.menu
.isEmpty() );
4183 * Clear the input field
4186 OO
.ui
.CapsuleMultiSelectWidget
.prototype.clearInput = function () {
4187 if ( this.$input
) {
4188 this.$input
.val( '' );
4189 this.updateInputSize();
4192 this.popup
.toggle( false );
4194 this.menu
.toggle( false );
4195 this.menu
.selectItem();
4196 this.menu
.highlightItem();
4202 OO
.ui
.CapsuleMultiSelectWidget
.prototype.setDisabled = function ( disabled
) {
4206 OO
.ui
.CapsuleMultiSelectWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
4208 if ( this.$input
) {
4209 this.$input
.prop( 'disabled', this.isDisabled() );
4212 this.menu
.setDisabled( this.isDisabled() );
4215 this.popup
.setDisabled( this.isDisabled() );
4219 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
4220 this.items
[ i
].updateDisabled();
4230 * @return {OO.ui.CapsuleMultiSelectWidget}
4232 OO
.ui
.CapsuleMultiSelectWidget
.prototype.focus = function () {
4233 if ( !this.isDisabled() ) {
4235 this.popup
.setSize( this.$handle
.width() );
4236 this.popup
.toggle( true );
4237 this.popup
.$element
.find( '*' )
4238 .filter( function () { return OO
.ui
.isFocusableElement( $( this ), true ); } )
4242 this.updateInputSize();
4243 this.menu
.toggle( true );
4244 this.$input
.focus();
4251 * SelectFileWidgets allow for selecting files, using the HTML5 File API. These
4252 * widgets can be configured with {@link OO.ui.mixin.IconElement icons} and {@link
4253 * OO.ui.mixin.IndicatorElement indicators}.
4254 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
4257 * // Example of a file select widget
4258 * var selectFile = new OO.ui.SelectFileWidget();
4259 * $( 'body' ).append( selectFile.$element );
4261 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets
4264 * @extends OO.ui.Widget
4265 * @mixins OO.ui.mixin.IconElement
4266 * @mixins OO.ui.mixin.IndicatorElement
4267 * @mixins OO.ui.mixin.PendingElement
4268 * @mixins OO.ui.mixin.LabelElement
4271 * @param {Object} [config] Configuration options
4272 * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
4273 * @cfg {string} [placeholder] Text to display when no file is selected.
4274 * @cfg {string} [notsupported] Text to display when file support is missing in the browser.
4275 * @cfg {boolean} [droppable=true] Whether to accept files by drag and drop.
4276 * @cfg {boolean} [showDropTarget=false] Whether to show a drop target. Requires droppable to be true.
4277 * @cfg {Number} [thumbnailSizeLimit=20] File size limit in MiB above which to not try and show a
4278 * preview (for performance)
4280 OO
.ui
.SelectFileWidget
= function OoUiSelectFileWidget( config
) {
4283 // Configuration initialization
4284 config
= $.extend( {
4286 placeholder
: OO
.ui
.msg( 'ooui-selectfile-placeholder' ),
4287 notsupported
: OO
.ui
.msg( 'ooui-selectfile-not-supported' ),
4289 showDropTarget
: false,
4290 thumbnailSizeLimit
: 20
4293 // Parent constructor
4294 OO
.ui
.SelectFileWidget
.parent
.call( this, config
);
4296 // Mixin constructors
4297 OO
.ui
.mixin
.IconElement
.call( this, config
);
4298 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
4299 OO
.ui
.mixin
.PendingElement
.call( this, $.extend( {}, config
, { $pending
: this.$info
} ) );
4300 OO
.ui
.mixin
.LabelElement
.call( this, config
);
4303 this.$info
= $( '<span>' );
4304 this.showDropTarget
= config
.showDropTarget
;
4305 this.thumbnailSizeLimit
= config
.thumbnailSizeLimit
;
4306 this.isSupported
= this.constructor.static.isSupported();
4307 this.currentFile
= null;
4308 if ( Array
.isArray( config
.accept
) ) {
4309 this.accept
= config
.accept
;
4313 this.placeholder
= config
.placeholder
;
4314 this.notsupported
= config
.notsupported
;
4315 this.onFileSelectedHandler
= this.onFileSelected
.bind( this );
4317 this.selectButton
= new OO
.ui
.ButtonWidget( {
4318 classes
: [ 'oo-ui-selectFileWidget-selectButton' ],
4319 label
: OO
.ui
.msg( 'ooui-selectfile-button-select' ),
4320 disabled
: this.disabled
|| !this.isSupported
4323 this.clearButton
= new OO
.ui
.ButtonWidget( {
4324 classes
: [ 'oo-ui-selectFileWidget-clearButton' ],
4327 disabled
: this.disabled
4331 this.selectButton
.$button
.on( {
4332 keypress
: this.onKeyPress
.bind( this )
4334 this.clearButton
.connect( this, {
4335 click
: 'onClearClick'
4337 if ( config
.droppable
) {
4338 dragHandler
= this.onDragEnterOrOver
.bind( this );
4340 dragenter
: dragHandler
,
4341 dragover
: dragHandler
,
4342 dragleave
: this.onDragLeave
.bind( this ),
4343 drop
: this.onDrop
.bind( this )
4349 this.$label
.addClass( 'oo-ui-selectFileWidget-label' );
4351 .addClass( 'oo-ui-selectFileWidget-info' )
4352 .append( this.$icon
, this.$label
, this.clearButton
.$element
, this.$indicator
);
4354 if ( config
.droppable
&& config
.showDropTarget
) {
4355 this.selectButton
.setIcon( 'upload' );
4356 this.$thumbnail
= $( '<div>' ).addClass( 'oo-ui-selectFileWidget-thumbnail' );
4357 this.setPendingElement( this.$thumbnail
);
4358 this.$dropTarget
= $( '<div>' )
4359 .addClass( 'oo-ui-selectFileWidget-dropTarget' )
4361 click
: this.onDropTargetClick
.bind( this )
4366 this.selectButton
.$element
,
4368 .addClass( 'oo-ui-selectFileWidget-dropLabel' )
4369 .text( OO
.ui
.msg( 'ooui-selectfile-dragdrop-placeholder' ) )
4371 this.$element
.append( this.$dropTarget
);
4374 .addClass( 'oo-ui-selectFileWidget' )
4375 .append( this.$info
, this.selectButton
.$element
);
4382 OO
.inheritClass( OO
.ui
.SelectFileWidget
, OO
.ui
.Widget
);
4383 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IconElement
);
4384 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IndicatorElement
);
4385 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.PendingElement
);
4386 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.LabelElement
);
4388 /* Static Properties */
4391 * Check if this widget is supported
4396 OO
.ui
.SelectFileWidget
.static.isSupported = function () {
4398 if ( OO
.ui
.SelectFileWidget
.static.isSupportedCache
=== null ) {
4399 $input
= $( '<input>' ).attr( 'type', 'file' );
4400 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= $input
[ 0 ].files
!== undefined;
4402 return OO
.ui
.SelectFileWidget
.static.isSupportedCache
;
4405 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= null;
4412 * A change event is emitted when the on/off state of the toggle changes.
4414 * @param {File|null} value New value
4420 * Get the current value of the field
4422 * @return {File|null}
4424 OO
.ui
.SelectFileWidget
.prototype.getValue = function () {
4425 return this.currentFile
;
4429 * Set the current value of the field
4431 * @param {File|null} file File to select
4433 OO
.ui
.SelectFileWidget
.prototype.setValue = function ( file
) {
4434 if ( this.currentFile
!== file
) {
4435 this.currentFile
= file
;
4437 this.emit( 'change', this.currentFile
);
4444 * Focusses the select file button.
4448 OO
.ui
.SelectFileWidget
.prototype.focus = function () {
4449 this.selectButton
.$button
[ 0 ].focus();
4454 * Update the user interface when a file is selected or unselected
4458 OO
.ui
.SelectFileWidget
.prototype.updateUI = function () {
4460 if ( !this.isSupported
) {
4461 this.$element
.addClass( 'oo-ui-selectFileWidget-notsupported' );
4462 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
4463 this.setLabel( this.notsupported
);
4465 this.$element
.addClass( 'oo-ui-selectFileWidget-supported' );
4466 if ( this.currentFile
) {
4467 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
4469 $label
= $label
.add(
4471 .addClass( 'oo-ui-selectFileWidget-fileName' )
4472 .text( this.currentFile
.name
)
4474 if ( this.currentFile
.type
!== '' ) {
4475 $label
= $label
.add(
4477 .addClass( 'oo-ui-selectFileWidget-fileType' )
4478 .text( this.currentFile
.type
)
4481 this.setLabel( $label
);
4483 if ( this.showDropTarget
) {
4485 this.loadAndGetImageUrl().done( function ( url
) {
4486 this.$thumbnail
.css( 'background-image', 'url( ' + url
+ ' )' );
4487 }.bind( this ) ).fail( function () {
4488 this.$thumbnail
.append(
4489 new OO
.ui
.IconWidget( {
4491 classes
: [ 'oo-ui-selectFileWidget-noThumbnail-icon' ]
4494 }.bind( this ) ).always( function () {
4497 this.$dropTarget
.off( 'click' );
4500 if ( this.showDropTarget
) {
4501 this.$dropTarget
.off( 'click' );
4502 this.$dropTarget
.on( {
4503 click
: this.onDropTargetClick
.bind( this )
4507 .css( 'background-image', '' );
4509 this.$element
.addClass( 'oo-ui-selectFileWidget-empty' );
4510 this.setLabel( this.placeholder
);
4516 * If the selected file is an image, get its URL and load it.
4518 * @return {jQuery.Promise} Promise resolves with the image URL after it has loaded
4520 OO
.ui
.SelectFileWidget
.prototype.loadAndGetImageUrl = function () {
4521 var deferred
= $.Deferred(),
4522 file
= this.currentFile
,
4523 reader
= new FileReader();
4527 ( OO
.getProp( file
, 'type' ) || '' ).indexOf( 'image/' ) === 0 &&
4528 file
.size
< this.thumbnailSizeLimit
* 1024 * 1024
4530 reader
.onload = function ( event
) {
4531 var img
= document
.createElement( 'img' );
4532 img
.addEventListener( 'load', function () {
4534 img
.naturalWidth
=== 0 ||
4535 img
.naturalHeight
=== 0 ||
4536 img
.complete
=== false
4540 deferred
.resolve( event
.target
.result
);
4543 img
.src
= event
.target
.result
;
4545 reader
.readAsDataURL( file
);
4550 return deferred
.promise();
4554 * Add the input to the widget
4558 OO
.ui
.SelectFileWidget
.prototype.addInput = function () {
4559 if ( this.$input
) {
4560 this.$input
.remove();
4563 if ( !this.isSupported
) {
4568 this.$input
= $( '<input>' ).attr( 'type', 'file' );
4569 this.$input
.on( 'change', this.onFileSelectedHandler
);
4570 this.$input
.on( 'click', function ( e
) {
4571 // Prevents dropTarget to get clicked which calls
4572 // a click on this input
4573 e
.stopPropagation();
4578 if ( this.accept
) {
4579 this.$input
.attr( 'accept', this.accept
.join( ', ' ) );
4581 this.selectButton
.$button
.append( this.$input
);
4585 * Determine if we should accept this file
4588 * @param {string} File MIME type
4591 OO
.ui
.SelectFileWidget
.prototype.isAllowedType = function ( mimeType
) {
4594 if ( !this.accept
|| !mimeType
) {
4598 for ( i
= 0; i
< this.accept
.length
; i
++ ) {
4599 mimeTest
= this.accept
[ i
];
4600 if ( mimeTest
=== mimeType
) {
4602 } else if ( mimeTest
.substr( -2 ) === '/*' ) {
4603 mimeTest
= mimeTest
.substr( 0, mimeTest
.length
- 1 );
4604 if ( mimeType
.substr( 0, mimeTest
.length
) === mimeTest
) {
4614 * Handle file selection from the input
4617 * @param {jQuery.Event} e
4619 OO
.ui
.SelectFileWidget
.prototype.onFileSelected = function ( e
) {
4620 var file
= OO
.getProp( e
.target
, 'files', 0 ) || null;
4622 if ( file
&& !this.isAllowedType( file
.type
) ) {
4626 this.setValue( file
);
4631 * Handle clear button click events.
4635 OO
.ui
.SelectFileWidget
.prototype.onClearClick = function () {
4636 this.setValue( null );
4641 * Handle key press events.
4644 * @param {jQuery.Event} e Key press event
4646 OO
.ui
.SelectFileWidget
.prototype.onKeyPress = function ( e
) {
4647 if ( this.isSupported
&& !this.isDisabled() && this.$input
&&
4648 ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
4650 this.$input
.click();
4656 * Handle drop target click events.
4659 * @param {jQuery.Event} e Key press event
4661 OO
.ui
.SelectFileWidget
.prototype.onDropTargetClick = function () {
4662 if ( this.isSupported
&& !this.isDisabled() && this.$input
) {
4663 this.$input
.click();
4669 * Handle drag enter and over events
4672 * @param {jQuery.Event} e Drag event
4674 OO
.ui
.SelectFileWidget
.prototype.onDragEnterOrOver = function ( e
) {
4676 droppableFile
= false,
4677 dt
= e
.originalEvent
.dataTransfer
;
4680 e
.stopPropagation();
4682 if ( this.isDisabled() || !this.isSupported
) {
4683 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
4684 dt
.dropEffect
= 'none';
4688 // DataTransferItem and File both have a type property, but in Chrome files
4689 // have no information at this point.
4690 itemOrFile
= OO
.getProp( dt
, 'items', 0 ) || OO
.getProp( dt
, 'files', 0 );
4692 if ( this.isAllowedType( itemOrFile
.type
) ) {
4693 droppableFile
= true;
4695 // dt.types is Array-like, but not an Array
4696 } else if ( Array
.prototype.indexOf
.call( OO
.getProp( dt
, 'types' ) || [], 'Files' ) !== -1 ) {
4697 // File information is not available at this point for security so just assume
4698 // it is acceptable for now.
4699 // https://bugzilla.mozilla.org/show_bug.cgi?id=640534
4700 droppableFile
= true;
4703 this.$element
.toggleClass( 'oo-ui-selectFileWidget-canDrop', droppableFile
);
4704 if ( !droppableFile
) {
4705 dt
.dropEffect
= 'none';
4712 * Handle drag leave events
4715 * @param {jQuery.Event} e Drag event
4717 OO
.ui
.SelectFileWidget
.prototype.onDragLeave = function () {
4718 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
4722 * Handle drop events
4725 * @param {jQuery.Event} e Drop event
4727 OO
.ui
.SelectFileWidget
.prototype.onDrop = function ( e
) {
4729 dt
= e
.originalEvent
.dataTransfer
;
4732 e
.stopPropagation();
4733 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
4735 if ( this.isDisabled() || !this.isSupported
) {
4739 file
= OO
.getProp( dt
, 'files', 0 );
4740 if ( file
&& !this.isAllowedType( file
.type
) ) {
4744 this.setValue( file
);
4753 OO
.ui
.SelectFileWidget
.prototype.setDisabled = function ( disabled
) {
4754 OO
.ui
.SelectFileWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
4755 if ( this.selectButton
) {
4756 this.selectButton
.setDisabled( disabled
);
4758 if ( this.clearButton
) {
4759 this.clearButton
.setDisabled( disabled
);
4765 * Progress bars visually display the status of an operation, such as a download,
4766 * and can be either determinate or indeterminate:
4768 * - **determinate** process bars show the percent of an operation that is complete.
4770 * - **indeterminate** process bars use a visual display of motion to indicate that an operation
4771 * is taking place. Because the extent of an indeterminate operation is unknown, the bar does
4772 * not use percentages.
4774 * The value of the `progress` configuration determines whether the bar is determinate or indeterminate.
4777 * // Examples of determinate and indeterminate progress bars.
4778 * var progressBar1 = new OO.ui.ProgressBarWidget( {
4781 * var progressBar2 = new OO.ui.ProgressBarWidget();
4783 * // Create a FieldsetLayout to layout progress bars
4784 * var fieldset = new OO.ui.FieldsetLayout;
4785 * fieldset.addItems( [
4786 * new OO.ui.FieldLayout( progressBar1, {label: 'Determinate', align: 'top'}),
4787 * new OO.ui.FieldLayout( progressBar2, {label: 'Indeterminate', align: 'top'})
4789 * $( 'body' ).append( fieldset.$element );
4792 * @extends OO.ui.Widget
4795 * @param {Object} [config] Configuration options
4796 * @cfg {number|boolean} [progress=false] The type of progress bar (determinate or indeterminate).
4797 * To create a determinate progress bar, specify a number that reflects the initial percent complete.
4798 * By default, the progress bar is indeterminate.
4800 OO
.ui
.ProgressBarWidget
= function OoUiProgressBarWidget( config
) {
4801 // Configuration initialization
4802 config
= config
|| {};
4804 // Parent constructor
4805 OO
.ui
.ProgressBarWidget
.parent
.call( this, config
);
4808 this.$bar
= $( '<div>' );
4809 this.progress
= null;
4812 this.setProgress( config
.progress
!== undefined ? config
.progress
: false );
4813 this.$bar
.addClass( 'oo-ui-progressBarWidget-bar' );
4816 role
: 'progressbar',
4818 'aria-valuemax': 100
4820 .addClass( 'oo-ui-progressBarWidget' )
4821 .append( this.$bar
);
4826 OO
.inheritClass( OO
.ui
.ProgressBarWidget
, OO
.ui
.Widget
);
4828 /* Static Properties */
4830 OO
.ui
.ProgressBarWidget
.static.tagName
= 'div';
4835 * Get the percent of the progress that has been completed. Indeterminate progresses will return `false`.
4837 * @return {number|boolean} Progress percent
4839 OO
.ui
.ProgressBarWidget
.prototype.getProgress = function () {
4840 return this.progress
;
4844 * Set the percent of the process completed or `false` for an indeterminate process.
4846 * @param {number|boolean} progress Progress percent or `false` for indeterminate
4848 OO
.ui
.ProgressBarWidget
.prototype.setProgress = function ( progress
) {
4849 this.progress
= progress
;
4851 if ( progress
!== false ) {
4852 this.$bar
.css( 'width', this.progress
+ '%' );
4853 this.$element
.attr( 'aria-valuenow', this.progress
);
4855 this.$bar
.css( 'width', '' );
4856 this.$element
.removeAttr( 'aria-valuenow' );
4858 this.$element
.toggleClass( 'oo-ui-progressBarWidget-indeterminate', !progress
);
4862 * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
4863 * and a menu of search results, which is displayed beneath the query
4864 * field. Unlike {@link OO.ui.mixin.LookupElement lookup menus}, search result menus are always visible to the user.
4865 * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
4866 * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
4868 * Each time the query is changed, the search result menu is cleared and repopulated. Please see
4869 * the [OOjs UI demos][1] for an example.
4871 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/#dialogs-mediawiki-vector-ltr
4874 * @extends OO.ui.Widget
4877 * @param {Object} [config] Configuration options
4878 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
4879 * @cfg {string} [value] Initial query value
4881 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
4882 // Configuration initialization
4883 config
= config
|| {};
4885 // Parent constructor
4886 OO
.ui
.SearchWidget
.parent
.call( this, config
);
4889 this.query
= new OO
.ui
.TextInputWidget( {
4891 placeholder
: config
.placeholder
,
4894 this.results
= new OO
.ui
.SelectWidget();
4895 this.$query
= $( '<div>' );
4896 this.$results
= $( '<div>' );
4899 this.query
.connect( this, {
4900 change
: 'onQueryChange',
4901 enter
: 'onQueryEnter'
4903 this.query
.$input
.on( 'keydown', this.onQueryKeydown
.bind( this ) );
4907 .addClass( 'oo-ui-searchWidget-query' )
4908 .append( this.query
.$element
);
4910 .addClass( 'oo-ui-searchWidget-results' )
4911 .append( this.results
.$element
);
4913 .addClass( 'oo-ui-searchWidget' )
4914 .append( this.$results
, this.$query
);
4919 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
4924 * Handle query key down events.
4927 * @param {jQuery.Event} e Key down event
4929 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
4930 var highlightedItem
, nextItem
,
4931 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
4934 highlightedItem
= this.results
.getHighlightedItem();
4935 if ( !highlightedItem
) {
4936 highlightedItem
= this.results
.getSelectedItem();
4938 nextItem
= this.results
.getRelativeSelectableItem( highlightedItem
, dir
);
4939 this.results
.highlightItem( nextItem
);
4940 nextItem
.scrollElementIntoView();
4945 * Handle select widget select events.
4947 * Clears existing results. Subclasses should repopulate items according to new query.
4950 * @param {string} value New value
4952 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
4954 this.results
.clearItems();
4958 * Handle select widget enter key events.
4960 * Chooses highlighted item.
4963 * @param {string} value New value
4965 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
4966 var highlightedItem
= this.results
.getHighlightedItem();
4967 if ( highlightedItem
) {
4968 this.results
.chooseItem( highlightedItem
);
4973 * Get the query input.
4975 * @return {OO.ui.TextInputWidget} Query input
4977 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
4982 * Get the search results menu.
4984 * @return {OO.ui.SelectWidget} Menu of search results
4986 OO
.ui
.SearchWidget
.prototype.getResults = function () {
4987 return this.results
;
4991 * NumberInputWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
4992 * can be entered manually) and two {@link OO.ui.ButtonWidget button widgets}
4993 * (to adjust the value in increments) to allow the user to enter a number.
4996 * // Example: A NumberInputWidget.
4997 * var numberInput = new OO.ui.NumberInputWidget( {
4998 * label: 'NumberInputWidget',
4999 * input: { value: 5, min: 1, max: 10 }
5001 * $( 'body' ).append( numberInput.$element );
5004 * @extends OO.ui.Widget
5007 * @param {Object} [config] Configuration options
5008 * @cfg {Object} [input] Configuration options to pass to the {@link OO.ui.TextInputWidget text input widget}.
5009 * @cfg {Object} [minusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget decrementing button widget}.
5010 * @cfg {Object} [plusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget incrementing button widget}.
5011 * @cfg {boolean} [isInteger=false] Whether the field accepts only integer values.
5012 * @cfg {number} [min=-Infinity] Minimum allowed value
5013 * @cfg {number} [max=Infinity] Maximum allowed value
5014 * @cfg {number} [step=1] Delta when using the buttons or up/down arrow keys
5015 * @cfg {number|null} [pageStep] Delta when using the page-up/page-down keys. Defaults to 10 times #step.
5017 OO
.ui
.NumberInputWidget
= function OoUiNumberInputWidget( config
) {
5018 // Configuration initialization
5019 config
= $.extend( {
5027 // Parent constructor
5028 OO
.ui
.NumberInputWidget
.parent
.call( this, config
);
5031 this.input
= new OO
.ui
.TextInputWidget( $.extend(
5033 disabled
: this.isDisabled()
5037 this.minusButton
= new OO
.ui
.ButtonWidget( $.extend(
5039 disabled
: this.isDisabled(),
5044 classes
: [ 'oo-ui-numberInputWidget-minusButton' ],
5048 this.plusButton
= new OO
.ui
.ButtonWidget( $.extend(
5050 disabled
: this.isDisabled(),
5055 classes
: [ 'oo-ui-numberInputWidget-plusButton' ],
5061 this.input
.connect( this, {
5062 change
: this.emit
.bind( this, 'change' ),
5063 enter
: this.emit
.bind( this, 'enter' )
5065 this.input
.$input
.on( {
5066 keydown
: this.onKeyDown
.bind( this ),
5067 'wheel mousewheel DOMMouseScroll': this.onWheel
.bind( this )
5069 this.plusButton
.connect( this, {
5070 click
: [ 'onButtonClick', +1 ]
5072 this.minusButton
.connect( this, {
5073 click
: [ 'onButtonClick', -1 ]
5077 this.setIsInteger( !!config
.isInteger
);
5078 this.setRange( config
.min
, config
.max
);
5079 this.setStep( config
.step
, config
.pageStep
);
5081 this.$field
= $( '<div>' ).addClass( 'oo-ui-numberInputWidget-field' )
5083 this.minusButton
.$element
,
5084 this.input
.$element
,
5085 this.plusButton
.$element
5087 this.$element
.addClass( 'oo-ui-numberInputWidget' ).append( this.$field
);
5088 this.input
.setValidation( this.validateNumber
.bind( this ) );
5093 OO
.inheritClass( OO
.ui
.NumberInputWidget
, OO
.ui
.Widget
);
5098 * A `change` event is emitted when the value of the input changes.
5104 * An `enter` event is emitted when the user presses 'enter' inside the text box.
5112 * Set whether only integers are allowed
5113 * @param {boolean} flag
5115 OO
.ui
.NumberInputWidget
.prototype.setIsInteger = function ( flag
) {
5116 this.isInteger
= !!flag
;
5117 this.input
.setValidityFlag();
5121 * Get whether only integers are allowed
5122 * @return {boolean} Flag value
5124 OO
.ui
.NumberInputWidget
.prototype.getIsInteger = function () {
5125 return this.isInteger
;
5129 * Set the range of allowed values
5130 * @param {number} min Minimum allowed value
5131 * @param {number} max Maximum allowed value
5133 OO
.ui
.NumberInputWidget
.prototype.setRange = function ( min
, max
) {
5135 throw new Error( 'Minimum (' + min
+ ') must not be greater than maximum (' + max
+ ')' );
5139 this.input
.setValidityFlag();
5143 * Get the current range
5144 * @return {number[]} Minimum and maximum values
5146 OO
.ui
.NumberInputWidget
.prototype.getRange = function () {
5147 return [ this.min
, this.max
];
5151 * Set the stepping deltas
5152 * @param {number} step Normal step
5153 * @param {number|null} pageStep Page step. If null, 10 * step will be used.
5155 OO
.ui
.NumberInputWidget
.prototype.setStep = function ( step
, pageStep
) {
5157 throw new Error( 'Step value must be positive' );
5159 if ( pageStep
=== null ) {
5160 pageStep
= step
* 10;
5161 } else if ( pageStep
<= 0 ) {
5162 throw new Error( 'Page step value must be positive' );
5165 this.pageStep
= pageStep
;
5169 * Get the current stepping values
5170 * @return {number[]} Step and page step
5172 OO
.ui
.NumberInputWidget
.prototype.getStep = function () {
5173 return [ this.step
, this.pageStep
];
5177 * Get the current value of the widget
5180 OO
.ui
.NumberInputWidget
.prototype.getValue = function () {
5181 return this.input
.getValue();
5185 * Get the current value of the widget as a number
5186 * @return {number} May be NaN, or an invalid number
5188 OO
.ui
.NumberInputWidget
.prototype.getNumericValue = function () {
5189 return +this.input
.getValue();
5193 * Set the value of the widget
5194 * @param {string} value Invalid values are allowed
5196 OO
.ui
.NumberInputWidget
.prototype.setValue = function ( value
) {
5197 this.input
.setValue( value
);
5201 * Adjust the value of the widget
5202 * @param {number} delta Adjustment amount
5204 OO
.ui
.NumberInputWidget
.prototype.adjustValue = function ( delta
) {
5205 var n
, v
= this.getNumericValue();
5208 if ( isNaN( delta
) || !isFinite( delta
) ) {
5209 throw new Error( 'Delta must be a finite number' );
5216 n
= Math
.max( Math
.min( n
, this.max
), this.min
);
5217 if ( this.isInteger
) {
5218 n
= Math
.round( n
);
5230 * @param {string} value Field value
5233 OO
.ui
.NumberInputWidget
.prototype.validateNumber = function ( value
) {
5235 if ( isNaN( n
) || !isFinite( n
) ) {
5239 /*jshint bitwise: false */
5240 if ( this.isInteger
&& ( n
| 0 ) !== n
) {
5243 /*jshint bitwise: true */
5245 if ( n
< this.min
|| n
> this.max
) {
5253 * Handle mouse click events.
5256 * @param {number} dir +1 or -1
5258 OO
.ui
.NumberInputWidget
.prototype.onButtonClick = function ( dir
) {
5259 this.adjustValue( dir
* this.step
);
5263 * Handle mouse wheel events.
5266 * @param {jQuery.Event} event
5268 OO
.ui
.NumberInputWidget
.prototype.onWheel = function ( event
) {
5271 // Standard 'wheel' event
5272 if ( event
.originalEvent
.deltaMode
!== undefined ) {
5273 this.sawWheelEvent
= true;
5275 if ( event
.originalEvent
.deltaY
) {
5276 delta
= -event
.originalEvent
.deltaY
;
5277 } else if ( event
.originalEvent
.deltaX
) {
5278 delta
= event
.originalEvent
.deltaX
;
5281 // Non-standard events
5282 if ( !this.sawWheelEvent
) {
5283 if ( event
.originalEvent
.wheelDeltaX
) {
5284 delta
= -event
.originalEvent
.wheelDeltaX
;
5285 } else if ( event
.originalEvent
.wheelDeltaY
) {
5286 delta
= event
.originalEvent
.wheelDeltaY
;
5287 } else if ( event
.originalEvent
.wheelDelta
) {
5288 delta
= event
.originalEvent
.wheelDelta
;
5289 } else if ( event
.originalEvent
.detail
) {
5290 delta
= -event
.originalEvent
.detail
;
5295 delta
= delta
< 0 ? -1 : 1;
5296 this.adjustValue( delta
* this.step
);
5303 * Handle key down events.
5306 * @param {jQuery.Event} e Key down event
5308 OO
.ui
.NumberInputWidget
.prototype.onKeyDown = function ( e
) {
5309 if ( !this.isDisabled() ) {
5310 switch ( e
.which
) {
5312 this.adjustValue( this.step
);
5314 case OO
.ui
.Keys
.DOWN
:
5315 this.adjustValue( -this.step
);
5317 case OO
.ui
.Keys
.PAGEUP
:
5318 this.adjustValue( this.pageStep
);
5320 case OO
.ui
.Keys
.PAGEDOWN
:
5321 this.adjustValue( -this.pageStep
);
5330 OO
.ui
.NumberInputWidget
.prototype.setDisabled = function ( disabled
) {
5332 OO
.ui
.NumberInputWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
5335 this.input
.setDisabled( this.isDisabled() );
5337 if ( this.minusButton
) {
5338 this.minusButton
.setDisabled( this.isDisabled() );
5340 if ( this.plusButton
) {
5341 this.plusButton
.setDisabled( this.isDisabled() );